essential-hooks-collection

🪝 Essential Hooks Collection

A collection of essential React hooks.

🚀 Features

✅ TypeScript Support
✅ Optimized for React 18+
✅ JavaScript & TypeScript Compatibility
✅ Typedoc-Generated Documentation

📦 Installation

Using npm:

npm install essential-hooks-collection

Using yarn:

yarn add essential-hooks-collection

🔧 Usage

Import the hooks in your React project:

import { useLocalStorage, useWindowSize } from "essential-hooks-collection";

For a full list of hooks and their API documentation, visit:
📖 Typedoc Documentation

📝 Documentation

This library uses TypeDoc to generate API documentation.

To generate documentation locally:

npm run docs

To deploy the documentation to GitHub Pages, run:

npm run docs:deploy

Live Documentation:
📖 View Docs

🧪 Running Tests

This library includes Jest tests for all hooks.

To run tests:

npm test

To run tests in watch mode:

npm run test:watch

To check test coverage:

npm run test:coverage

📜 License

This project is licensed under the MIT License.
See the full license here.

🤝 Contributing

💡 How to Contribute

• Fork the repository 📌
• Create a new branch (git checkout -b feature/new-hook)
• Push to the branch (git push origin feature/new-hook)
• Open a pull request 🚀