https://github.com/raathigesh/hooks.guide

🏗 Collection of React hooks curated by the community
https://github.com/raathigesh/hooks.guide

Last synced: 13 days ago
JSON representation

🏗 Collection of React hooks curated by the community

• Host: GitHub
• URL: https://github.com/raathigesh/hooks.guide
• Owner: Raathigesh
• License: mit
• Created: 2018-10-30T10:47:52.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2022-06-16T18:08:58.000Z (over 2 years ago)
• Last Synced: 2024-10-22T16:01:52.964Z (21 days ago)
• Language: JavaScript
• Homepage: https://hooks-guide.netlify.com/
• Size: 1.09 MB
• Stars: 525
• Watchers: 13
• Forks: 47
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


    

 


  



[![All Contributors](https://img.shields.io/badge/all_contributors-4-orange.svg?style=flat-square)](#contributors)

- 🍎 Handpicked hooks to learn from or copy/paste or experiment

- 💡 All code snippets are interactive

- 🎈 Copy snippets to clipboard with a click

- 💄 Prettify the snippets




### 🏗 How do I add a new Hook?

The hooks are documented using markdown in `public/docs` directory.

To add a new hook,

- Add a new markdown file under a folder.

  - Document the hook under `community` folder if the hook doesn't belong to a published npm module.

    > Refer `public/docs/template.md` for documentation guide

- Make a pull request




### 🧡 Contribute

- Run `yarn install`

- Run `yarn start` to start the app in dev mode

- If you add a new markdown file, you have to go to `src/docs.js` file and just make a dummy change to trigger a webpack build. This runs the babel macro again.




### 👩‍🎨 Contributors

Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):

| [
Raathigeshan Kugarajan](https://twitter.com/Raathigesh)
[💻](https://github.com/Raathigesh/hooks.guide/commits?author=Raathigesh "Code") [🎨](#design-Raathigesh "Design") [💡](#example-Raathigesh "Examples") [📖](https://github.com/Raathigesh/hooks.guide/commits?author=Raathigesh "Documentation") | [
Vivek Nayyar](https://www.viveknayyar.in/)
[💻](https://github.com/Raathigesh/hooks.guide/commits?author=vivek12345 "Code") [💡](#example-vivek12345 "Examples") [📖](https://github.com/Raathigesh/hooks.guide/commits?author=vivek12345 "Documentation") | [
Piotr Pietrzak](https://github.com/hasparus)
[📖](https://github.com/Raathigesh/hooks.guide/commits?author=hasparus "Documentation") | [
Ivan Mironchik](https://github.com/aiven715)
[💡](#example-aiven715 "Examples") |

| :---: | :---: | :---: | :---: |

This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome!