4a3ce4cc1d
Add comprehensive reference documentation for: - Vitest: environments, projects/workspaces, type testing, vi utilities - Pinia: HMR, Nuxt integration, SSR setup - Vue: built-in components (Transition, Teleport, Suspense, KeepAlive) and advanced directives
51 lines
1002 B
Markdown
51 lines
1002 B
Markdown
---
|
|
category: Browser
|
|
---
|
|
|
|
# useCssVar
|
|
|
|
Manipulate CSS variables
|
|
|
|
## Usage
|
|
|
|
```ts
|
|
import { useCssVar } from '@vueuse/core'
|
|
import { useTemplateRef } from 'vue'
|
|
|
|
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' })
|
|
```
|
|
|
|
## Type Declarations
|
|
|
|
```ts
|
|
export interface UseCssVarOptions extends ConfigurableWindow {
|
|
initialValue?: string
|
|
/**
|
|
* Use MutationObserver to monitor variable changes
|
|
* @default false
|
|
*/
|
|
observe?: boolean
|
|
}
|
|
/**
|
|
* Manipulate CSS variables.
|
|
*
|
|
* @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>
|
|
```
|