VueUse 中文网

主题

useStyleTag ​

将活性 style 元素注入文档头。

¥Inject reactive style element in head.

示例 ​

源代码演练场

Edit CSS:

ID: vueuse_styletag_1

Loaded: false

用法 ​

¥Usage

基本用法 ​

¥Basic usage

提供一个 CSS 字符串，那么 useStyleTag 会自动生成一个 id 并将其注入到 <head> 中。

¥Provide a CSS string, then useStyleTag will automatically generate an id and inject it in <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>：

¥This code will be injected to <head>:

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

自定义 ID ​

¥Custom ID

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

¥If you need to define your own id, you can pass id as first argument.

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>

媒体查询 ​

¥Media query

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

¥You can pass media attributes as last argument within object.

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
  /**
   * Nonce value for CSP (Content Security Policy)
   *
   * @default undefined
   */
  nonce?: string
}
export interface UseStyleTagReturn {
  id: string
  css: ShallowRef<string>
  load: () => void
  unload: () => void
  isLoaded: Readonly<ShallowRef<boolean>>
}
/**
 * Inject <style> element in head.
 *
 * Overload: Omitted id
 *
 * @see https://vueuse.org/useStyleTag
 * @param css
 * @param options
 */
export declare function useStyleTag(
  css: MaybeRef<string>,
  options?: UseStyleTagOptions,
): UseStyleTagReturn

源代码 ​

源代码 • 示例 • 文档

变更日志 ​

fa2c0 - feat: support passing nonce (#4749)