/react-outside-click-handler

:blossom: React Component for handling click events outside a specific component.

Primary LanguageJavaScriptMIT LicenseMIT

react-outside-click-handler Build Status Coverage Status npm version

⚠️ This repository not maintained. Please check out airbnb/react-outside-click-handler.

React Component for handling click events outside a specific component.

Table of contents

Installation

react-outside-click-handler requires React >= 0.14.

$ npm install --save react-outside-click-handler

Alternatively, using yarn:

$ yarn add react-outside-click-handler

API

  • <OutsideClickHandler children useCapture onOutsideClick />

props

  • children (ReactNode): The specific inner react node that not trigger onOutsideClick handler.
  • useCapture (Boolean): See link's useCapture section (Default: true)
  • onOutsideClick (Function): Click event handler outside children react node.

Usage

<OutsideClickHandler useCapture onOutsideClick={Function}>
  <p>The specific inner react node.</p>
  <p>When this nodes are clicked, "onOutsideClick" is not triggered.</p>
</OutsideClickHandler>

Credits

This component is inspired by airbnb/react-dates's OutsideClickHandler.

License

MIT © Taehwan Noh