JAVASCRIPT

Custom Hook for Detecting Clicks Outside an Element

Create a reusable React custom hook to detect clicks outside a specified DOM element, perfect for closing dropdowns, modals, or context menus when users click elsewhere.

import { useEffect, useRef } from 'react';

function useClickOutside(handler) {
  const domRef = useRef();

  useEffect(() => {
    const listener = (event) => {
      if (!domRef.current || domRef.current.contains(event.target)) {
        return;
      }
      handler(event);
    };

    document.addEventListener('mousedown', listener);
    document.addEventListener('touchstart', listener);

    return () => {
      document.removeEventListener('mousedown', listener);
      document.removeEventListener('touchstart', listener);
    };
  }, [handler]);

  return domRef;
}
How it works: The `useClickOutside` hook provides a ref that, when attached to a component, triggers the provided `handler` function whenever a click or touch event occurs outside of that component. It utilizes `useEffect` to manage global event listeners, ensuring they are properly added and removed to prevent memory leaks, making it ideal for dismissing UI elements like dropdowns or modals.

Need help integrating this into your project?

Our team of expert developers can help you build your custom application from scratch.

Hire DigitalCodeLabs