@omtanke/react-use-event-outside
Version:
Detect event outside
32 lines (30 loc) • 1.31 kB
JavaScript
import { useEffect, useRef } from 'react';
export default function useEventListener(eventName, handler, element = window) {
// Create a ref that stores handler
const savedHandler = useRef();
// Update ref.current value if handler changes.
// This allows our effect below to always get latest handler ...
// ... without us needing to pass it in effect deps array ...
// ... and potentially cause effect to re-run every render.
useEffect(() => {
savedHandler.current = handler;
}, [handler]);
useEffect(
() => {
// Make sure element supports addEventListener
// On
const isSupported = element && element.addEventListener;
if (!isSupported) return;
// Create event listener that calls handler function stored in ref
const eventListener = (event) => savedHandler.current(event);
// Add event listener
element.addEventListener(eventName, eventListener);
// Remove event listener on cleanup
// eslint-disable-next-line consistent-return
return () => {
element.removeEventListener(eventName, eventListener);
};
},
[eventName, element], // Re-run if eventName or element changes
);
}