Launch Week Day 5: Introducing Reachability for PHP.Learn More
Socket
Book a DemoSign in
Socket

react-click-away-listener

Package Overview
Dependencies
Maintainers
1
Versions
59
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

react-click-away-listener

A simple click away listener built with React Hooks

Source
npmnpm
Version
1.6.0
Version published
Maintainers
1
Created
Source

~700B React Click Away Listener

npm Coverage Status CI Tests downloads/month pullrequest firsttimersonly

Installation

yarn add react-click-away-listener
  • It's quite small in size.
  • It's built with TypeScript.
  • It supports both Mouse and Touch Events.
  • It works with Portals.

Usage

import ClickAwayListener from 'react-click-away-listener';

const App = () => {
	const handleClickAway = () => {
		console.log('Hey, you can close the Popup now');
	};

	return (
		<div id="app">
			<ClickAwayListener onClickAway={handleClickAway}>
				<div> Some Popup, Nav or anything </div>
			</ClickAwayListener>
			<div id="rest-of-the-app">Don't name a div like that :(</div>
		</div>
	);
};

Props

PropDefault valueDescription
onClickAwayundefinedFires when a user clicks outside the click away component
asdivThe rendered element type
mouseEventclickThe mouse event type that gets fired on ClickAway
touchEventtouchendThe touch event type that gets fired on ClickAway

Examples

LICENSE

MIT

FAQs

Package last updated on 06 Feb 2021

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