https://github.com/dimitarchristoff/react-outerclick
HOC wrapper for React Components (class) to handle outside clicks with a frugal document event strategy.
https://github.com/dimitarchristoff/react-outerclick
Last synced: about 1 year ago
JSON representation
HOC wrapper for React Components (class) to handle outside clicks with a frugal document event strategy.
- Host: GitHub
- URL: https://github.com/dimitarchristoff/react-outerclick
- Owner: DimitarChristoff
- Created: 2016-11-01T16:01:17.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-09-17T14:03:11.000Z (over 7 years ago)
- Last Synced: 2025-04-12T21:05:23.979Z (about 1 year ago)
- Language: JavaScript
- Homepage: http://dimitarchristoff.github.io/react-outerclick/
- Size: 493 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# react-outerclick
HOC wrapper with frugal document event strategy
> NB: this will work with React Classes, not with stateless components
Get a callback when a click happens outside of your component. If your React class implements `handleOuterClick`, it will get called when a click outside of the root node for your element takes place.
## Installation
```bash
npm i react-outerclick
```
## Usage
As a HOC, you can use the experimental decorator style:
```js
import React from 'react';
import outerClick from 'react-outerclick';
@outerClick
class Foo extends React.Component {
state = {
opened: true
};
handleOuterClick(event){
this.setState({
opened: false
});
}
render(){
return
Foo. Click elsewhere;
}
}
export default Foo;
```
Alternatively, without `stage-0` and `babel-plugin-transform-decorators-legacy`, this looks like so:
```js
import React from 'react';
import outerClick from 'react-outerclick';
class Foo extends React.Component {
constructor(props){
super(props);
this.state = {
opened: true
};
}
handleOuterClick(event){
this.setState({
opened: false
});
}
render(){
return
Foo. Click elsewhere;
}
}
// decorate here:
export default outerClick(Foo);
```
## Why?
Because:
- need to be able to do this with a low footprint - so a single document event handler for all elements that need it.
- gets `element.ownerDocument` correctly so can work in popups/tearoffs, unlike other implementations
## Limitations
Hot Module Reloading (react-hmre, react-hot-loader etc) any component that has an outerClick handler will cause the outer click functionality to fail as it's not going to find the old component instance and there is no lifecycle method that is available to refresh the event subscriptions.
## Found an issue, or want to contribute?
If you find an issue, want to start a discussion on something related to this project, or have suggestions on how to improve it? Please [create an issue](../../issues/new)!
See an error and want to fix it? Want to add a file or otherwise make some changes? All contributions are welcome!
## License
MIT