@piplup/use-event-listener/index.d.ts

React hook designed to simplify the process of adding event listeners to various DOM elements in React applications.

import * as React from 'react';
export declare function useEventListener<EventName extends keyof MediaQueryListEventMap>(eventName: EventName, handler: (event: MediaQueryListEventMap[EventName]) => void, element: React.RefObject<MediaQueryList>, options?: AddEventListenerOptions | boolean): void;
export declare function useEventListener<EventName extends keyof WindowEventMap>(eventName: EventName, handler: (event: WindowEventMap[EventName]) => void, element?: undefined, options?: AddEventListenerOptions | boolean): void;
export declare function useEventListener<EventName extends keyof HTMLElementEventMap, T extends HTMLElement = HTMLDivElement>(eventName: EventName, handler: (event: HTMLElementEventMap[EventName]) => void, element: React.RefObject<T>, options?: AddEventListenerOptions | boolean): void;
export declare function useEventListener<EventName extends keyof DocumentEventMap>(eventName: EventName, handler: (event: DocumentEventMap[EventName]) => void, element: React.RefObject<Document>, options?: AddEventListenerOptions | boolean): void;
export declare function useEventListener<EventName extends string, EventElement extends HTMLElement = HTMLDivElement>(eventName: EventName, handler: (event: Event) => void, element?: React.RefObject<EventElement>, options?: AddEventListenerOptions | boolean): void;