@ozen-ui/kit
Version:
React component library
16 lines (15 loc) • 932 B
TypeScript
import type { RefObject } from 'react';
export interface UseClickOutside {
/** Массив refs для которых необходимо игнорировать внешние клики */
refs?: ReadonlyArray<RefObject<HTMLElement>>;
/** Функция обратного вызова которая будет вызвана при внешнем клике */
handler?(event: MouseEvent): void;
/** Событие клика */
eventName?: 'mousedown' | 'mouseup' | 'click';
/** вкл. / выкл. */
active?: boolean;
/** Опции для метода addEventListener (третий аргумент) */
options?: AddEventListenerOptions;
}
/** Хук отслеживающий клики за пределами dom-элементов указанных в `refs` */
export declare function useClickOutside({ refs, handler, options, active, eventName, }: UseClickOutside): void;