useTheme API

API reference for the useTheme composable.

Options

ThemeAdapter

The theme adapter to use.

ID

The default theme ID to select on initialization.

TokenCollection

A collection of tokens to use for resolving theme colors.

Record<ID, Z>

A record of themes to register.

string | HTMLElement

The target element or selector to apply theme classes to.

ComputedRef<Record<string, Colors>>

A computed reference to the resolved colors of the current theme.

Readonly<Ref<boolean, boolean>>

A ref indicating whether the current theme is dark.

(themes?: ID[]) => void

Cycles through the provided themes in order.