@d3vtool/hooks/dist/useClickOutside/useClickOutside.d.ts

Collection of custom React hooks to simplify tasks in your React projects.

/**
 * A custom React hook that triggers a callback function when a click event occurs outside the referenced element.
 *
 * This hook returns a mutable ref object which should be assigned to the `ref` prop of an element.
 * When the user clicks outside of the referenced element, the provided `action` function will be invoked.
 *
 * @param action - The function to be triggered when a click occurs outside the element.
 * @returns A React mutable ref object that should be assigned to the `ref` of the target element.
 *
 * @template T - The type of the element the hook is attached to. It must extend HTMLElement.
 *
 * @example
 * const ref = useClickOutside(() => {
 *   console.log('Clicked outside');
 * });
 *
 * return <div ref={ref}>Content</div>;
 */
export declare function useClickOutside<T extends HTMLElement>(action: VoidFunction): import("react").RefObject<T | null>;