Skip to content
πŸ”₯A collection of beautiful and (hopefully) useful React hooks to speed-up your components and hooks development πŸ”₯
JavaScript Shell
Branch: master
Clone or download
antonioru Merge pull request #55 from beautifulinteractions/hotfix/useCondition…
…alTimeout

Adding types for useConditionalTimeout
Latest commit ffe7c92 Jan 21, 2020
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github ci: 🎑 add travis config (#33) Jan 6, 2020
docs useConditionalTimeout hook Jan 21, 2020
scripts πŸ“ Doc refactorying Jan 9, 2020
src Adding types for useConditionalTimeout Jan 21, 2020
test 🎨 πŸ“ useViewportSpy hook + improved documentation Jan 10, 2020
.babelrc πŸ•Ά Project setup, few initial hooks Dec 20, 2019
.eslintignore πŸ“ Doc refactorying Jan 9, 2020
.eslintrc Merge pull request #47 from beautifulinteractions/feature/useDrag Jan 14, 2020
.gitignore Merge pull request #47 from beautifulinteractions/feature/useDrag Jan 14, 2020
.huskyrc Merge pull request #47 from beautifulinteractions/feature/useDrag Jan 14, 2020
.nycrc πŸ€– Few documentation typos fixed Dec 28, 2019
.travis.yml Merge pull request #47 from beautifulinteractions/feature/useDrag Jan 14, 2020
CHANGELOG.md Adding types for useConditionalTimeout Jan 21, 2020
CODE_OF_CONDUCT.md πŸ“ code of conduct Dec 30, 2019
CONTRIBUTING.md πŸ“ code of conduct Dec 30, 2019
HOOK_DOCUMENTATION_TEMPLATE.md πŸ“ Doc refactorying Jan 9, 2020
LICENSE Initial commit Dec 18, 2019
README.md useConditionalTimeout hook Jan 21, 2020
index.d.ts Adding types for useConditionalTimeout Jan 21, 2020
logo.png Readme update [skip ci] Jan 10, 2020
package-lock.json useConditionalTimeout hook Jan 21, 2020
package.json Adding types for useConditionalTimeout Jan 21, 2020
usage_example.png πŸ“ replacing usage example image Jan 2, 2020

README.md

Build Status License: MIT npm GitHub stars

Beautiful React Hooks


A collection of beautiful (and hopefully useful) React hooks to speed-up your components and hooks development

Usage example

πŸ’‘ Why?

React custom hooks allow to abstract components' business logic into single reusable functions.
So far, I've found that most of the hooks I've created and therefore shared between my projects have quite often a similar gist that involves callback references, events and components' lifecycle.
For this reason I've tried to sum up that gist into beautiful-react-hooks: a collection of (hopefully) useful React hooks to possibly help other developers to speed up their development process.

Furthermore, I've tried to create a concise yet concrete API having in mind the code readability, focusing to keep the learning curve as lower as possible so that the it can be used and shared in bigger teams.

-- Please before using any hook, read its documentation! --

β˜•οΈ Features

  • Concise API
  • Small and lightweight
  • Easy to learn
  • Functional approach
  • Fully written in JS (although TS types are supported)

πŸ•Ί Install

by using npm:

$ npm install beautiful-react-hooks

by using yarn:

$ yarn add beautiful-react-hooks

🎨 Hooks

Contributing

Contributions are very welcome and wanted.

To submit your custom hook, please make sure your read our CONTRIBUTING guidelines.

Before submitting a new merge request, please make sure:

  1. You have updated the package.json version and reported your changes into the CHANGELOG file
  2. make sure you run npm test and npm build before submitting your merge request.
  3. make sure you've added the documentation of your custom hook (you can possibly use the HOOK_DOCUMENTATION_TEMPLATE to document your custom hook).
  4. make sure you've updated the index.d.ts file with your hook types.

Made with

Credits

This library is provided and sponsored by:

As part of our commitment to support and provide the open source community.


Icon made by Freepik from www.flaticon.com

You can’t perform that action at this time.