30-seconds-of-code/react/snippets/use-click-outside.md

title, type, tags, author, cover, dateModified

title	type	tags	author	cover	dateModified
React useClickOutside hook	snippet	hooks effect event	chalarangelo	clutter	2020-11-16T14:17:53+02:00

Handles the event of clicking outside of the wrapped component.

• Create a custom hook that takes a ref and a callback to handle the click event.
• Use the useEffect() hook to append and clean up the click event.
• Use the useRef() hook to create a ref for your click component and pass it to the useClickOutside hook.

const useClickOutside = (ref, callback) => {
  const handleClick = e => {
    if (ref.current && !ref.current.contains(e.target)) {
      callback();
    }
  };
  React.useEffect(() => {
    document.addEventListener('click', handleClick);
    return () => {
      document.removeEventListener('click', handleClick);
    };
  });
};

const ClickBox = ({ onClickOutside }) => {
  const clickRef = React.useRef();
  useClickOutside(clickRef, onClickOutside);
  return (
    <div
      className="click-box"
      ref={clickRef}
      style={{
        border: '2px dashed orangered',
        height: 200,
        width: 400,
        display: 'flex',
        justifyContent: 'center',
        alignItems: 'center'
      }}
    >
      <p>Click out of this element</p>
    </div>
  );
};

ReactDOM.createRoot(document.getElementById('root')).render(
  <ClickBox onClickOutside={() => alert('click outside')} />
);