Skip to content
aq-ui
Back to HooksHook

Use Preferred Color Scheme

Open-code aq-ui React hook for Use Preferred Color Scheme.

Installation

pnpm dlx aq-ui@alpha add use-preferred-color-scheme

API reference

Client module

Import the parts you need, then jump to an export for its contract.

View full source

Quick start

"use client"

import { usePreferredColorScheme } from "@/hooks/use-preferred-color-scheme"

const result = usePreferredColorScheme()

PreferredColorScheme

typeSource L5

Type contract for PreferredColorScheme.

type PreferredColorScheme = "light" | "dark"

usePreferredColorScheme

functionSource L7

Open-code aq-ui React hook for Use Preferred Color Scheme.

function usePreferredColorScheme(defaultValue: PreferredColorScheme = "light"): PreferredColorScheme
Returns
PreferredColorScheme

Parameters

NameTypeDefault
defaultValue?PreferredColorScheme"light"
const result = usePreferredColorScheme()

Registry dependencies

use-media-query

Files

  • hooks/use-preferred-color-scheme.ts

Source