useCssVars() — vue Function Reference

Architecture documentation for the useCssVars() function in useCssVars.ts from the vue codebase.

Function typescript CompilerSFC StyleProcessor

Entity Profile

CompilerSFC→ StyleProcessor→ useCssVars() — vue Function Reference

Dependency Diagram

graph TD
  b7375bae_ab11_cc53_6884_d4fe581eda6b["useCssVars()"]
  67a194e4_a410_0dbd_e240_af7947944cfb["useCssVars.ts"]
  b7375bae_ab11_cc53_6884_d4fe581eda6b -->|defined in| 67a194e4_a410_0dbd_e240_af7947944cfb
  style b7375bae_ab11_cc53_6884_d4fe581eda6b fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

src/v3/sfc-helpers/useCssVars.ts lines 9–34

export function useCssVars(
  getter: (
    vm: Record<string, any>,
    setupProxy: Record<string, any>
  ) => Record<string, string>
) {
  if (!inBrowser && !__TEST__) return

  const instance = currentInstance
  if (!instance) {
    __DEV__ &&
      warn(`useCssVars is called without current active component instance.`)
    return
  }

  watchPostEffect(() => {
    const el = instance.$el
    const vars = getter(instance, instance._setupProxy!)
    if (el && el.nodeType === 1) {
      const style = (el as HTMLElement).style
      for (const key in vars) {
        style.setProperty(`--${key}`, vars[key])
      }
    }
  })
}