https://github.com/vikramsamak/react-extended-hooks
A collection of React custom hooks providing extended functionality for geolocation, platform details, battery status, and more.
https://github.com/vikramsamak/react-extended-hooks
battery-status geolocat navigator-api platform-detection react react-custom-hooks speech-synthesis typescript utility-hooks
Last synced: 3 months ago
JSON representation
A collection of React custom hooks providing extended functionality for geolocation, platform details, battery status, and more.
- Host: GitHub
- URL: https://github.com/vikramsamak/react-extended-hooks
- Owner: vikramsamak
- License: mit
- Created: 2024-12-10T17:30:50.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-12-29T05:37:40.000Z (6 months ago)
- Last Synced: 2025-03-30T04:05:47.342Z (3 months ago)
- Topics: battery-status, geolocat, navigator-api, platform-detection, react, react-custom-hooks, speech-synthesis, typescript, utility-hooks
- Language: TypeScript
- Homepage: https://react-extended-hooks-storybook.vercel.app/
- Size: 644 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# React Util Hooks
A collection of utility hooks for React that leverage browser APIs to enhance your application with minimal effort.
## Features
- **`useBatteryDetails`**
Provides detailed battery status, including charge level, charging status, and time to full/empty.
- **`useGeolocationDetails`**
Fetches the user's geolocation details, including latitude, longitude, and other related information.
- **`useSpeechSynthesis`**
Enables text-to-speech functionality with adjustable pitch, rate, volume, and voice selection.
- **`usePlatformDetails`**
Retrieves platform-specific information such as user agent, browser language, and online status.
- **`useClipBoardDetails`**
Allows interaction with the clipboard, enabling copying text to the clipboard and reading clipboard content with built-in state tracking.
## Installation
```bash
npm install react-extended-hooks
```
## Peer Dependencies
Ensure the following peer dependencies are installed in your project:
- `react`
- `react-dom`
- `lodash`
You can install them using:
```bash
npm install react react-dom lodash
```
## Documentation
Comprehensive documentation and usage examples are available at:
[react-extended-hooks-storybook](https://react-extended-hooks-storybook.vercel.app/)
---
Contributions and feedback are welcome! 🚀