跳至内容

useStyleTag

类别
导出大小
474 B
上次更改
上周

在头部注入响应式style元素。

演示

编辑 CSS

ID: vueuse_styletag_1

已加载: false

用法

基本用法

提供一个 CSS 字符串,然后useStyleTag将自动生成一个 id 并将其注入到<head>中。

js
import { useStyleTag } from '@vueuse/core'

const {
  id,
  css,
  load,
  unload,
  isLoaded,
} = useStyleTag('.foo { margin-top: 32px; }')

// Later you can modify styles
css.value = '.foo { margin-top: 64px; }'

此代码将注入到<head>

html
<style id="vueuse_styletag_1">
  .foo {
    margin-top: 64px;
  }
</style>

自定义 ID

如果需要定义自己的 id,可以将id作为第一个参数传递。

js
import { useStyleTag } from '@vueuse/core'

useStyleTag('.foo { margin-top: 32px; }', { id: 'custom-id' })
html
<!-- injected to <head> -->
<style id="custom-id">
  .foo {
    margin-top: 32px;
  }
</style>

媒体查询

可以将媒体属性作为对象中的最后一个参数传递。

js
useStyleTag('.foo { margin-top: 32px; }', { media: 'print' })
html
<!-- injected to <head> -->
<style id="vueuse_styletag_1" media="print">
  .foo {
    margin-top: 32px;
  }
</style>

类型声明

typescript
export interface UseStyleTagOptions extends ConfigurableDocument {
  /**
   * Media query for styles to apply
   */
  media?: string
  /**
   * Load the style immediately
   *
   * @default true
   */
  immediate?: boolean
  /**
   * Manual controls the timing of loading and unloading
   *
   * @default false
   */
  manual?: boolean
  /**
   * DOM id of the style tag
   *
   * @default auto-incremented
   */
  id?: string
}
export interface UseStyleTagReturn {
  id: string
  css: Ref<string>
  load: () => void
  unload: () => void
  isLoaded: Readonly<Ref<boolean>>
}
/**
 * Inject <style> element in head.
 *
 * Overload: Omitted id
 *
 * @see https://vueuse.org.cn/useStyleTag
 * @param css
 * @param options
 */
export declare function useStyleTag(
  css: MaybeRef<string>,
  options?: UseStyleTagOptions,
): UseStyleTagReturn

源代码

源代码演示文档

贡献者

Anthony Fu
sibbng
James Wragg
Anthony Fu
mrayi
Jelf

变更日志

v12.0.0-beta.1 于 2024/11/21
0a9ed - feat!: 放弃 Vue 2 支持,优化包体并清理代码 (#4349)
v9.7.0 于 2022/12/16
cfcc2 - fix: 允许使用多行 CSS (#2476)
v9.6.0 于 2022/11/22
94413 - fix: 允许使用现有节点 (#2442)

在 MIT 许可证下发布。