JSPM

  • Created
  • Published
  • Downloads 1821
  • Score
    100M100P100Q126832F
  • License MIT

React hook for tracking clicks outside a ref

Package Exports

  • @rooks/use-outside-click

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@rooks/use-outside-click) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@rooks/use-outside-click

Note: Future updates to this package have moved to the main package rooks. All hooks now reside in a single package which you can install using

npm install rooks

or

yarn add rooks

Rooks is completely treeshakeable and if you use only 1 of the 50+ hooks in the package, only that hook will be bundled with your code. Your bundle will only contain the hooks that you need. Cheers!

TitleCard

Build Status

About

Outside click(for a ref) event as hook for React.

Installation

npm install --save @rooks/use-outside-click

Importing the hook

import useOutsideClick from "@rooks/use-outside-click";

Usage

function Demo() {
  const pRef = useRef();
  function outsidePClick() {
    alert("Clicked outside p");
  }
  useOutsideClick(pRef, outsidePClick);
  return (
    <div>
      <p ref={pRef}>Click outside me</p>
    </div>
  );
}

render(<Demo />);