Custom React Hooks Library

Website

https://custom-react-hooks-live.vercel.app/

Github

https://github.com/djkepa/custom-react-hooks

🌟 Table of Contents

• Installation
• Hooks List
• Links
• Contributing
• License

🚀 Installation

Choose and install individual hooks that suit your project needs, or install the entire collection for a full suite of utilities.

Installing All Hooks

If you prefer to have all hooks at your disposal, you can install the entire collection:

npm install @custom-react-hooks/all

or

yarn add @custom-react-hooks/all

Installing Specific Hooks

Each hook is a standalone package, and you can install them individually using npm or yarn:

npm install @custom-react-hooks/use-async

or

yarn add @custom-react-hooks/use-async

Importing the Hook

The useExample hook must be imported using a named import as shown below:

Named Import:

import { useExample } from '@custom-react-hooks/use-example';

This approach ensures that the hook integrates seamlessly into your project, maintaining consistency and predictability in how you use our package.

📚 Hooks List

A list of available hooks and their respective documentation can be found below:

• useAsync
• useClickOutside
• useClipboard
• useDebounce
• useDocumentTitle
• useDragDrop
• useEffectOnce
• useElementSize
• useEventListener
• useFetch
• useForm
• useGeoLocation
• useHover
• useIdle
• useImageLoad
• useKeyPress
• useLockBodyScroll
• useLongPress
• useMediaDevices
• useMediaQuery
• useMouse
• useOnScreen
• useOrientation
• usePermission
• usePortal
• useScript
• useStatus
• useStep
• useStorage
• useThrottle
• useTimeout
• useToggle
• useUpdateEffect
• useWindowSize

🛠️ Contributing

Your contributions are welcome! Please read our Contributing Guidelines for details on how to submit pull requests, file bugs, and suggest enhancements.

🔗 Links

• GitHub Repository
• Issue Tracker

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.