qol-hooks/dist/esm/useOnClickOutside.d.ts

A collection of React hooks to improve the quality of life of developers.

/// <reference types="react" />
/**
 * @description A hook to call a function when a click event occurs outside a specified element
 * @param {React.RefObject<HTMLElement>} ref The reference to the element to check if the click event occurred outside
 * @param {(event: MouseEvent | TouchEvent) => void} handler The function to call when the click event occurs outside the element
 *
 * @example```tsx
 * const ref = useRef(null);
 * useOnClickOutside(ref, () => console.log("Clicked outside!"));
 *
 * return <div ref={ref}>Click outside me!</div>;
 * ```
 */
declare function useOnClickOutside(ref: React.RefObject<HTMLElement>, handler: (event: MouseEvent | TouchEvent) => void): void;
export default useOnClickOutside;