outside-click-handler

1.0.8 • Public • Published

OutsideClickHandler

Greenkeeper badge npm FlowType compatible

This component is designed to handle all clicks outside, for example, to open and close modal windows.

Features

  • Easy to use
  • Tests covered
  • Flowtype definitions
  • Lightweight (2.8kb gzip)

API

The component accepts two types of props: children and callback function. At componentDidMount() adds the listener, who is waiting for the click event, and componentWillUnmount() is removed.

type Props = {
  children: React.Node,
  onOutsideClick: Function,
};

How to use

class Wrapper extends React.Component {
  onClick = () => this.setState({ isShownHidden: !this.state.isShownHidden });
 
  render() {
    const { isShownHidden } = this.state;
    return (
      <OutsideClickHandler onOutsideClick={this.onClick}>
        <span>Im your child!</span>
        {isShownHidden && <span>Im your hidden child!</span>}
      </OutsideClickHandler>
    );
  }
}

Performance

If you want to use a component in lists, use conditions or methods to avoid poor performance.

Support

If you have any questions, please email me at botev.st@gmail.com or open the issue.

To use static typing, make sure that you have installed Flow.

Readme

Keywords

Package Sidebar

Install

npm i outside-click-handler

Weekly Downloads

4

Version

1.0.8

License

MIT

Unpacked Size

192 kB

Total Files

21

Last publish

Collaborators

  • yozhikm