useDarkMode

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

Installation

npx sse-tool add use-dark-mode

npm install sse-hooks

import { useDarkMode } from "./{hooks file}";

const { isDarkMode, toggle, enable, disable, set } = useDarkMode({
  defaultValue: true,
});

import { useDarkMode } from "sse-hooks";

const { isDarkMode, toggle, enable, disable, set } = useDarkMode({
  defaultValue: true,
});

Name	Type	Description
options	`DarkModeOptions`	The initial value of the dark mode, default `false`.

Returns DarkModeReturn.

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

c165d — feat: enhance useRoleGuard and useSSR hooks with additional options and documentation

30da4 — feat: add new hooks and their metadata

cf13e — feat: add custom hooks for step navigation, ternary dark mode, timeout, toggle, unmount, and window size

useUnmount

Custom hook that runs a cleanup function when the component is unmounted.

useDocumentTitle

Custom hook that sets the document title.