useStyleTag

分类

浏览器

导出大小

513 B

上次更改

5 个月前

在 head 中注入响应式 style 元素。

演示

源代码演示 (测试版)

编辑 CSS

ID: vueuse_styletag_1

已加载: false

用法

基本用法

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

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 作为第一个参数传入。

useStyleTag
('.foo { margin-top: 32px; }', { id
: 'custom-id' })

html

<!-- injected to <head> -->
<style id="custom-id">
  .foo {
    margin-top: 32px;
  }
</style>

媒体查询

您可以在对象中作为最后一个参数传入媒体属性。

useStyleTag
('.foo { margin-top: 32px; }', { media
: 'print' })

html

<!-- injected to <head> -->
<style id="vueuse_styletag_1" media="print">
  .foo {
    margin-top: 32px;
  }
</style>

类型声明

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.cn/useStyleTag
 * @param css
 * @param options
 */
export declare function useStyleTag
(
  css
: MaybeRef
<string>,
  options
?: UseStyleTagOptions,
): UseStyleTagReturn