Skip to content

Instantly share code, notes, and snippets.

@tkim90
Created August 10, 2021 07:05
Show Gist options
  • Select an option

  • Save tkim90/fd1eb87f07758e83cc24775300eb0d20 to your computer and use it in GitHub Desktop.

Select an option

Save tkim90/fd1eb87f07758e83cc24775300eb0d20 to your computer and use it in GitHub Desktop.
useOnClickOutside Hook
import * as React from "react";
export default function useOnClickOutside(ref, handler) {
React.useEffect(
() => {
const listener = (event) => {
// Do nothing if clicking ref's element or descendent elements
if (!ref.current || ref.current.contains(event.target)) {
return;
}
handler(event);
};
document.addEventListener("mousedown", listener);
document.addEventListener("touchstart", listener);
return () => {
document.removeEventListener("mousedown", listener);
document.removeEventListener("touchstart", listener);
};
},
// Add ref and handler to effect dependencies
// It's worth noting that because passed in handler is a new ...
// ... function on every render that will cause this effect ...
// ... callback/cleanup to run every render. It's not a big deal ...
// ... but to optimize you can wrap handler in useCallback before ...
// ... passing it into this hook.
[ref, handler]
);
}
// Usage:
const [menuOpen, setMenuOpen] = React.useState(false);
useOnClickOutside(list, () => setMenuOpen(false));
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment