useCssVar

类别

Browser

导出体积

796 B

上次更改

5 months ago

操作 CSS 变量

示例

源码 playground (beta)

示例文字，

示例文字，--color：

Usage

import { useTemplateRef } from 'vue'
import { useCssVar } from '@vueuse/core'

const el = useTemplateRef('el')
const color1 = useCssVar('--color', el)

const elv = useTemplateRef('elv')
const key = ref('--color')
const colorVal = useCssVar(key, elv)

const someEl = useTemplateRef('someEl')
const color2 = useCssVar('--color', someEl, { initialValue: '#eee' })

类型声明

typescript

export interface UseCssVarOptions extends ConfigurableWindow {
  initialValue?: string
  /**
   * 使用 MutationObserver 监听变量更改
   * @default false
   */
  observe?: boolean
}
/**
 * 操作 CSS 变量。
 *
 * @see https://vueuse.org/useCssVar
 * @param prop
 * @param target
 * @param options
 */
export declare function useCssVar(
  prop: MaybeRefOrGetter<string | null | undefined>,
  target?: MaybeElementRef,
  options?: UseCssVarOptions,
): ShallowRef<string | undefined, string | undefined>