🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more

react-outer-click

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

react-outer-click

React component and hook which detect mouse clicks outside of itself.

3.8.0
latest
Version published
Maintainers
1
Created

react-outer-click

React component and hook which detect mouse clicks outside of an element.

Usage

useOuterClick(refs, handler);

Parameters

  • refs a single ref or array of refs to not be handled the user has clicked
  • handler callback function to be called when the user has clicked

Example

import { useOuterClick } from 'react-outer-click';

const Example = (props) => {
  const el = useRef(null);

  useOuterClick(el, (event) => {
    event.preventDefault();
    console.log('Clicked outside');
  });

  return <div ref={el}>Example</div>;
};

OuterClick Component

<OuterClick onOuterClick={}></OuterClick>

Props

  • children elements that will not be handled when clicked
  • onOuterClick callback function to be called when the user has clicked

Example

import { OuterClick } from 'react-outer-click';

const Example = (props) => {
  return (
    <OuterClick
      onOuterClick={() => {
        event.preventDefault();
        console.log('Clicked outside');
      }}
    >
      Example
    </OuterClick>
  );
};

:warning: Previous versions of react-outer-click allowed OuterClick to be imported as default export. This is no longer supported and has been removed.

:information_source: The OuterClick component will wrap your children with a <div> element, and any additional props will be passed down. You can change the element rendered with the as prop:

  ...
  <OuterClick as="span" onOuterClick={...}>
    Example
  </OuterClick>
  ...

Requirements

Requires a minimum of React version 16.8.0. If you're on an older version of React, then checkout v1.

FAQs

Package last updated on 14 Apr 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts