useDarkTheme

Creates persistent dark-theme state backed by local storage. The returned ref controls whether the document has the dark attribute, and toggle() flips that state for UI switches or menu actions.

Importing

import { useDarkTheme } from '@almighty-shogun/vue-utils'

Usage

import { useDarkTheme } from '@almighty-shogun/vue-utils'

const { darkMode, toggle } = useDarkTheme();

toggle();

Returns

Name	Type	Description
darkMode	Ref<boolean>	Current dark-mode state.
toggle()	() => void	Flips darkMode and applies the new state to the document.

Type signature

declare function useDarkTheme(): UseDarkTheme;

type UseDarkTheme = {
    readonly darkMode: Ref<boolean>;

    toggle(): void;
};

Uses

• setDarkTheme