https://github.com/cawfree/react-use-events
Simple react hooks for event handling.
https://github.com/cawfree/react-use-events
event events hook react react-native use
Last synced: 2 months ago
JSON representation
Simple react hooks for event handling.
- Host: GitHub
- URL: https://github.com/cawfree/react-use-events
- Owner: cawfree
- License: mit
- Created: 2019-11-13T23:59:48.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-11-14T00:54:36.000Z (over 6 years ago)
- Last Synced: 2025-03-17T15:47:07.633Z (over 1 year ago)
- Topics: event, events, hook, react, react-native, use
- Language: JavaScript
- Size: 2.93 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# react-use-events
Simple react hooks for event handling.
## 🚀 Getting Started
Using [`npm`]():
```sh
npm install --save react-use-events
```
Using [`yarn`]():
```sh
yarn add react-use-events
```
## ✍️ Usage
```javascript
import React, { useEffect } from 'react';
import { useEvent, emitEvent } from 'react-use-events';
const eventName = 'SOME_EVENT_NAME';
export default () => {
// When your component is unmounted, the listener will be cleared.
const [ data ] = useEvent(
eventName,
// Define some initial data.
'No data received.',
);
useEffect(
() => {
// You can call this anywhere in your app; all registered
// components will be updated.
emitEvent(
eventName,
'Received some data.',
);
},
[],
);
return (
{data}
);
};
```
## ✌️ License
[MIT](https://opensource.org/licenses/MIT)