SSE Hooks

useBoolean

Custom hook that handles boolean state with useful utility functions.

Installation

npx sse-hooks add use-boolean

yarn dlx sse-hooks add use-boolean

pnpm dlx sse-hooks add use-boolean

deno run -A npm:sse-hooks add use-boolean

bunx sse-hooks add use-boolean

example.ts

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

const { value, setTrue, setFalse, toggle } = useBoolean(true);

Prop	Default	Type
`defaultValue`	`false`	`boolean` The initial value for the boolean state (default is `false`).

Return Value	Default	Type
`setFalse`	-	`() => void` Function to set the boolean state to `false`.
`setTrue`	-	`() => void` Function to set the boolean state to `true`.
`setValue`	-	`React.Dispatch<React.SetStateAction<boolean>>` Function to set the boolean state directly.
`toggle`	-	`() => void` Function to toggle the boolean state.
`value`	-	`boolean` The current boolean state value.

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

useCounter

Custom hook that manages a counter with increment, decrement, reset, and setCount functionalities.

useMap

Custom hook that manages a key-value `Map` state with setter actions.