preferences

Whether the user prefers a dark color scheme.


Package	`@vizejs/composable/preferences`
Own the source	`vize lib pull composable:preferences`
Runtime exports	`usePreferredDark`, `usePreferredColorScheme`, `usePreferredContrast`, `usePreferredReducedTransparency`
Gzip budget	1536 B

Usage

import { usePreferredDark, usePreferredColorScheme, usePreferredContrast, usePreferredReducedTransparency } from "@vizejs/composable/preferences";

Runtime contract

Utility	Category	Stability	SSR	Hydration	Cleanup	Targets	Host globals	Uses
`usePreferredDark`	media	experimental	deterministic-fallback	caller-managed	reactive-scope	web, desktop	`window`	`useMediaQuery`
`usePreferredColorScheme`	media	experimental	deterministic-fallback	caller-managed	reactive-scope	web, desktop	`window`	`useMediaQuery`
`usePreferredContrast`	media	experimental	deterministic-fallback	caller-managed	reactive-scope	web, desktop	`window`	`useMediaQuery`
`usePreferredReducedTransparency`	media	experimental	deterministic-fallback	caller-managed	reactive-scope	web, desktop	`window`	`useMediaQuery`

API

`usePreferredDark`

Whether the user prefers a dark color scheme. Shares useMediaQuery semantics: ssrValue (default false) during server rendering and subscription cleanup with the owning scope.

function usePreferredDark(options: UseMediaQueryOptions = {}): Readonly<Ref<boolean>>

`usePreferredColorScheme`

Reactive color scheme preference.

function usePreferredColorScheme( options: UsePreferenceOptions<ColorSchemePreference> = {}, ): ComputedRef<ColorSchemePreference>

`usePreferredContrast`

Reactive contrast preference.

function usePreferredContrast( options: UsePreferenceOptions<ContrastPreference> = {}, ): ComputedRef<ContrastPreference>

`usePreferredReducedTransparency`

Whether the user prefers reduced transparency.

function usePreferredReducedTransparency( options: UseMediaQueryOptions = {}, ): Readonly<Ref<boolean>>

Types

`UsePreferenceOptions`

Options for the multi-valued preference composables.

Member	Type	Description
`ssrPreference`?	`Preference`	Preference exposed during server rendering and whenever no media-query capability exists.