🪝 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
Copy

Using yarn:

yarn add essential-hooks-collection
Copy

---

🔧 Usage

Import the hooks in your React project:

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

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
Copy

To deploy the documentation to GitHub Pages, run:

npm run docs:deploy
Copy

Live Documentation:
📖 View Docs

---

🧪 Running Tests

This library includes Jest tests for all hooks.

To run tests:

npm test
Copy

To run tests in watch mode:

npm run test:watch
Copy

To check test coverage:

npm run test:coverage
Copy

---

🤝 Contributing

💡 How to Contribute

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

---