useDarkMode | /deps/usehooks-ts.ts | netzo@0.5.70

function useDarkMode

Deprecated

this useDarkMode's signature is deprecated, it now accepts an options object instead of multiple parameters.

import { useDarkMode } from "https://deno.land/x/netzo@0.5.70/deps/usehooks-ts.ts";

Deprecated

this useDarkMode's signature is deprecated, it now accepts an options object instead of multiple parameters.

useDarkMode(defaultValue: boolean, localStorageKey?: string): DarkModeOutput

Custom hook that returns the current state of the dark mode.

Examples

const { isDarkMode, toggle, enable, disable, set } = useDarkMode(false, 'my-key');

defaultValue: boolean

the initial value of the dark mode, default false.

optional

localStorageKey: string

the key to use in the local storage, default 'usehooks-ts-dark-mode'.

DarkModeOutput

An object containing the dark mode's state and its controllers.