react-cool-onclickoutside

React Cool Onclickoutside

This is a React hook to trigger callback when user clicks outside of the target component(s) area. It's a useful logic for UI interaction design (IxD) like dismiss a dropdown menu, modal or tooltip etc. You can check the features section to learn more.

⚡️ Live demo: https://react-cool-onclickoutside.netlify.app

❤️ it? ⭐️ it on GitHub or Tweet about it.

Features

• 🎣 Listen for clicks outside based on React hook.
• 👯‍♀️ Support multiple refs to cover more use cases.
• 🧻 Uses passive event listeners to improve scrolling performance.
• ⛔ Scrollbar can be excluded from the callback of outside clicks.
• 🙈 Ignore certain elements during the event loop.
• 🙉 Enable you to stop listening for outside clicks when needed.
• 📜 Support TypeScript type definition.
• 🗄️ Server-side rendering compatibility.
• 🦠 Tiny size (< 1KB gzipped). No external dependencies, aside for the react.

Requirement

To use react-cool-onclickoutside, you must use react@16.8.0 or greater which includes hooks.

Installation

This package is distributed via npm.

$ yarn add react-cool-onclickoutside
# or
$ npm install --save react-cool-onclickoutside

Usage

Common use case.

import React, { useState, useRef } from 'react';
import useOnclickOutside from 'react-cool-onclickoutside';

const Dropdown = () => {
  const [openMenu, setOpenMenu] = useState(false);
  const ref = useRef();

  useOnclickOutside(ref, () => {
    setOpenMenu(false);
  });

  const handleClickBtn = () => {
    setOpenMenu(!openMenu);
  };

  return (
    <div>
      <button onClick={handleClickBtn}>Button</button>
      {openMenu && <div ref={ref}>Menu</div>}
    </div>
  );
};

Support multiple refs. Callback only be triggered when user clicks outside of the registered components.

import React, { useState, useRef } from 'react';
import useOnclickOutside from 'react-cool-onclickoutside';

const App = () => {
  const [showTips, setShowTips] = useState(true);
  const t1Ref = useRef();
  const t2Ref = useRef();

  useOnclickOutside([t1Ref, t2Ref], () => {
    setShowTips(false);
  });

  return (
    <div>
      {showTips && (
        <>
          <div ref={t1Ref}>Tooltip 1</div>
          <div ref={t2Ref}>Tooltip 2</div>
        </>
      )}
    </div>
  );
};

Ignore Elements by CSS Class Name

You can tell react-cool-onclickoutside to ignore certain elements during the event loop by the ignore-onclickoutside CSS class name. If you want explicit control over the class name, use the ignoreClass option.

import React, { useState, useRef } from 'react';
import useOnclickOutside from 'react-cool-onclickoutside';

// Use default CSS class name
const App = () => {
  const ref = useRef();

  useOnclickOutside(ref, () => {
    // Do something...
  });

  return (
    <div>
      <div ref={ref}>I'm a 🍕</div>
      <div>Click me will trigger the event's callback</div>
      <div className="ignore-onclickoutside">
        Click me won't trigger the event's callback
      </div>
    </div>
  );
};

// Use the CSS class name that you defined
const App = () => {
  const ref = useRef();

  useOnclickOutside(
    ref,
    () => {
      // Do something...
    },
    { ignoreClass: 'my-ignore-class' }
  );

  return (
    <div>
      <div ref={ref}>I'm a 🍕</div>
      <div>Click me will trigger the event's callback</div>
      <div className="my-ignore-class">
        Click me won't trigger the event's callback
      </div>
    </div>
  );
};

Disabling the Event Listener

In case you want to disable the event listener for performance reasons or fulfill some use cases. We provide the disabled option for you. Once you set it as true, the callback won’t be triggered.

import React, { useState, useRef } from 'react';
import useOnclickOutside from 'react-cool-onclickoutside';

const App = () => {
  const [disabled, setDisabled] = useState(false);
  const ref = useRef();

  useOnclickOutside(
    ref,
    () => {
      // Do something...
    },
    { disabled }
  );

  const handleBtnClick = () => {
    setDisabled(true);
  };

  return (
    <div>
      <button onClick={handleBtnClick}>
        Stop listening for outside clicks
      </button>
      <div ref={ref}>I'm a 🍎</div>
    </div>
  );
};

API

type Ref = RefObject<HTMLElement>;
type Callback = (event?: Event) => void;

useOnclickOutside(ref: Ref | Ref[], callback: Callback, options?: object);

Parameters

You must pass the ref and callback to use this hook and you can access the event object via the callback parameter, default will be MouseEvent or TouchEvent.

const callback = (event) => {
  console.log('Event: ', event);
};

The options object may contain the following keys.

Key	Type	Default	Description
disabled	boolean	false	Enable/disable the event listener.
eventTypes	Array	['mousedown', 'touchstart']	Which events to listen for.
excludeScrollbar	boolean	false	Whether or not to listen (ignore) to browser scrollbar clicks.
ignoreClass	string	ignore-onclickoutside	To ignore certain elements during the event loop by the CSS class name that you defined.

Inspiration

• react-onclickoutside

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Welly 💻 📖 🚧

This project follows the all-contributors specification. Contributions of any kind welcome!