useUnmount

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

Installation

npx sse-hooks add use-unmount

yarn dlx sse-hooks add use-unmount

pnpm dlx sse-hooks add use-unmount

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

bunx sse-hooks add use-unmount

example.ts

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

useUnmount(() => {
  // Cleanup logic here
});

Prop	Default	Type
`func`	-	`() => void` The cleanup function to be executed on unmount.

Return Value	Default	Type
`return`	-	`void` Hook return 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

useIsMounted

Custom hook that determines if the component is currently mounted.

useDarkMode

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