useDarkMode

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

Installation

npx sse-hooks add use-dark-mode

yarn dlx sse-hooks add use-dark-mode

pnpm dlx sse-hooks add use-dark-mode

deno run -A npm:sse-hooks add use-dark-mode

bunx sse-hooks add use-dark-mode

example.ts

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

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

Prop	Default	Type
`options`	`{}`	`DarkModeOptions` The initial value of the dark mode, default `false`.

Return Value	Default	Type
`disable`	-	`() => void` Function to disable the dark mode.
`enable`	-	`() => void` Function to enable the dark mode.
`isDarkMode`	-	`boolean` The current state of the dark mode.
`set`	-	`(value: boolean) => void` Function to set a specific value to the dark mode.
`toggle`	-	`() => void` Function to toggle the dark mode.

No specific type aliases defined for this component.

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.