https://github.com/afonsovreis/essential-hooks-collection

A collection of essential React hooks to speed up web development.
https://github.com/afonsovreis/essential-hooks-collection

help-wanted hook hooks hooks-api-react react reactjs server-side

Last synced: 4 months ago
JSON representation

A collection of essential React hooks to speed up web development.

• Host: GitHub
• URL: https://github.com/afonsovreis/essential-hooks-collection
• Owner: AfonsoVReis
• License: mit
• Created: 2025-02-27T19:47:05.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-03-18T09:28:59.000Z (about 1 year ago)
• Last Synced: 2025-09-19T17:45:38.807Z (9 months ago)
• Topics: help-wanted, hook, hooks, hooks-api-react, react, reactjs, server-side
• Language: TypeScript
• Homepage: https://afonsovreis.github.io/essential-hooks-collection/
• Size: 550 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 🪝 Essential Hooks Collection

[![npm version](https://badge.fury.io/js/essential-hooks-collection.svg)](https://www.npmjs.com/package/essential-hooks-collection)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

[![Build & Tests](https://github.com/AfonsoVReis/essential-hooks-collection/actions/workflows/test.yml/badge.svg)](https://github.com/AfonsoVReis/essential-hooks-collection/actions)

A **collection of essential React hooks**.

## 🚀 Features

✅ **TypeScript Support**  

✅ **Optimized for React 18+**  

✅ **JavaScript & TypeScript Compatibility**  

✅ **Typedoc-Generated Documentation**

---

## 📦 Installation

Using **npm**:

```sh

npm install essential-hooks-collection

```

Using **yarn**:

```sh

yarn add essential-hooks-collection

```

---

## 🔧 Usage

Import the hooks in your React project:

```tsx

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

```

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

📖 **[Typedoc Documentation](https://AfonsoVReis.github.io/essential-hooks-collection/)**

---

## 📝 Documentation

This library uses **TypeDoc** to generate API documentation.

To generate documentation locally:

```sh

npm run docs

```

To deploy the documentation to **GitHub Pages**, run:

```sh

npm run docs:deploy

```

Live Documentation:  

📖 **[View Docs](https://AfonsoVReis.github.io/essential-hooks-collection/)**

---

## 🧪 Running Tests

This library includes **Jest tests** for all hooks.

To run tests:

```sh

npm test

```

To run tests in **watch mode**:

```sh

npm run test:watch

```

To check **test coverage**:

```sh

npm run test:coverage

```

---

## 🤝 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** 🚀

---