🧰 Installation

Using npm or yarn 📦

# Using npm
npm i use-custom-hooks

# Using yarn
yarn add use-custom-hooks

📘 Available Hooks

• useForm
• useStack
• useQueue
• useToggle
• usePrevious
• useDebounce
• useDarkMode
• useMediaQuery
• useGeoLocation
• useLocalStorage
• useMousePosition
• useOfflineStatus

📄 Documentation

For documentation, examples and other details refer Documentation

🤝🏻 Contributing

Guidelines 📋

Please read CONTRIBUTING for Code of Conduct, details and the process for submitting pull requests to us.

Basic steps:

1. Open an issue explaining the changes.
2. Work on the issue after you get assigned.
3. Fork this repo.
4. Install the dependencies using npm install.
5. Make the changes.
6. Check for linting errors using npm run lint.
7. Open PR when the feature/fix is ready.
8. The collaborators will review your PR and if approved will merge to the master.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

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

📜 License

Copyright (c) 2020 Aromal Anil

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

✍🏻 Creator

Aromal Anil