useDarkMode
Custom hook that returns the current state of the dark mode.
Custom hook that returns the current state of the dark mode.
Usage
import { useDarkMode } from "@tilt-legal/cubitt-components/utilities/hooks";
const { isDarkMode, toggle, enable, disable, set } = useDarkMode({ defaultValue: true });API
Signature
declare function useDarkMode(options?: DarkModeOptions): DarkModeReturn;Parameters
| Parameter | Type | Description | Default |
|---|---|---|---|
[options] | ?DarkModeOptions | The initial value of the dark mode, default false. | - |
Return Value
| Value | Type | Description |
|---|---|---|
return | DarkModeReturn | An object containing the dark mode's state and its controllers. |