@react-hookz/web
Version:
React hooks done right, for browser and SSR.
39 lines (38 loc) • 1.45 kB
JavaScript
import { useEffect } from 'react';
import { useSyncedRef } from '../useSyncedRef/index.js';
import { off, on } from '../util/misc.js';
const DEFAULT_EVENTS = ['mousedown', 'touchstart'];
/**
* Triggers a callback when the user clicks outside a target element.
*
* @param ref React ref object containing the target HTML element.
* @param callback Callback invoked when the user clicks outside the target element.
* @param events List of events that will be used as triggers for the outside click. Default:
* 'mousedown', 'touchstart'
*/
export function useClickOutside(ref, callback, events = DEFAULT_EVENTS) {
const cbRef = useSyncedRef(callback);
const refRef = useSyncedRef(ref);
useEffect(() => {
function handler(event) {
if (!refRef.current.current) {
return;
}
const { target: evtTarget } = event;
const cb = cbRef.current;
if (!evtTarget ||
(Boolean(evtTarget) && !refRef.current.current.contains(evtTarget))) {
cb.call(this, event);
}
}
for (const name of events) {
on(document, name, handler, { passive: true });
}
return () => {
for (const name of events) {
off(document, name, handler, { passive: true });
}
};
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [...events]);
}