/usehooks-ts

React hook library, ready to use, written in Typescript.

Primary LanguageTypeScriptMIT LicenseMIT

usehooks-ts banner


usehooks-ts

React hook library, ready to use, written in Typescript.

Netlify Status Open Source? Yes! Maintained License lerna npm bundle size npm All Contributors


npm i usehooks-ts

Created by Julien Caron and maintained with ❤️ by an amazing team of developers.

🤔 About

Initially, usehooks-ts was a Gatsby powered blog hosted with Github & netlify that publishes easy to understand React Hook code snippets.

But now, it's a monorepo containing:

  • A static website used as hooks documentation (Link).
  • An NPM package containing the hooks library (Link).

If you'd like to submit new post ideas, improve existing posts, or change anything about the website feel free to submit an issue or pull-request.

📖 Summary

👉 Installation

Note: The project uses Node@^16 and npm@^8.

Two ways:

  1. Install usehooks-ts from npm to use it in your project.
  2. Install the current whole repository to contribute to it.

1. Install usehooks-ts

npm i usehooks-ts

Then go to the documentation.

2. Develop usehooks-ts

# Clone the repository
git clone https://github.com/juliencrn/usehooks-ts.git
cd usehooks-ts

# Install dependencies and setup
npm run bootstrap

# Start (Will start the frontend and the test:watch for the hooks packages)
npm start

# Generate a new hook
npm run plop

# Exec types-checking, linters and tests
npm run test

See more in package.json.

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Julien

🖋 💻 🎨 🤔

a777med

💻

Nguyen Tien Dat

💻

Elias Cohenca

🖋

João Deroldo

🐛 💻

Nishit

💻

Jon Koops

💻

LoneRifle

💻

Viktor

🤔 🐛

Bruno Clermont

💬

yoannesbourg

🤔

Strange2x

🤔

Jason Pickens

🐛

Sel-Vin Kuik

🐛

isaac

🐛

Bruno RZN

💻 👀

Nathan Manceaux-Panot

💻 👀

Dien Vu

🤔

Oleg Kusov

🤔

Matthew Guy

🤔

andrewbihl

🐛

lancepollard

🐛

Mukul Bansal

🐛

Jean-Luc Mongrain sur la Brosse

💻 🤔

Nic

🖋

Dan Wood

💻

jo wendenbuerger

🐛

Andrew Nosenko

🐛

CharlieJhonSmith

💻

Sullivan SENECHAL

🤔

Jason Long

🐛

kxm766

🐛

Quentin

💻 🤔 🖋

Daniel Lazar

💻 🐛

Mark Terrel

🐛 💻

Andreas Herd

🐛

Sonjoy Datta

💻

Ilya Belsky

🐛

James Barrett

💻

AbbalYouness

💻

This project follows the all-contributors specification. Contributions of any kind welcome!

🚗 Roadmap

  • Add new hooks
  • Develop automated tests for all hooks
  • Add a live preview system to interact with hooks

📝 License

This project is MIT licensed.