![\"usefy](\"https://raw.githubusercontent.com/mirunamu00/usefy/master/assets/logo.png\"){kind=logo}
\n\n \n
\n A type-safe React hook that runs a callback when a component unmounts\n
\n\n\n \n ![\"npm](\"https://img.shields.io/npm/v/@usefy/use-unmount.svg?style=flat-square&color=007acc\")
\n \n \n ![\"npm](\"https://img.shields.io/npm/dm/@usefy/use-unmount.svg?style=flat-square&color=007acc\")
\n \n \n ![\"bundle](\"https://img.shields.io/bundlephobia/minzip/@usefy/use-unmount?style=flat-square&color=007acc\")
![\"license\"](\"https://img.shields.io/npm/l/@usefy/use-unmount.svg?style=flat-square&color=007acc\")
\n \n
\n Installation •\n Quick Start •\n API Reference •\n Examples •\n Testing •\n License\n
\n\n\n \n 📚 View Storybook Demo\n \n
\n\n---\n\n## Overview\n\n`@usefy/use-unmount` runs a callback exactly when a component unmounts. Unlike a raw `useEffect` cleanup, the callback always sees the **latest** state and props (closure freshness), errors thrown inside it are caught so they never break the rest of the unmount, and cleanup can be turned on or off with the `enabled` option — its value is read at unmount time.\n\n**Part of the [@usefy](https://www.npmjs.com/org/usefy) ecosystem** — a collection of production-ready React hooks designed for modern applications.\n\n### Why use-unmount?\n\n- **Closure Freshness** — The callback always sees the latest state/props at unmount time\n- **Runs Only on Unmount** — Toggling `enabled` while mounted never fires the callback; it fires only on real unmount\n- **Error Handling** — Errors thrown in the callback are caught and logged, never breaking the component tree unmount\n- **TypeScript First** — Full type safety with the exported `UseUnmountOptions` interface\n- **SSR Compatible** — Safe to render on the server (Next.js, Remix); the callback never runs during SSR\n- **Zero Dependencies** — Pure React implementation with only a peer dependency on React\n\n---\n\n## Installation\n\n```bash\n# npm\nnpm install @usefy/use-unmount\n\n# yarn\nyarn add @usefy/use-unmount\n\n# pnpm\npnpm add @usefy/use-unmount\n```\n\n### Peer Dependencies\n\nThis package requires React 18 or 19:\n\n```json\n{\n \"peerDependencies\": {\n \"react\": \"^18.0.0 || ^19.0.0\"\n }\n}\n```\n\n---\n\n## Quick Start\n\n```tsx\nimport { useUnmount } from \"@usefy/use-unmount\";\n\nfunction MyComponent() {\n useUnmount(() => {\n console.log(\"Component unmounted\");\n });\n\n return\n Built with care by the usefy team\n
\n","readmeFilename":"README.md"}