@stardust-ui/react-component-event-listener/dist/es/types.d.ts

React components for binding events on the global scope.

import * as React from 'react';
export interface EventListenerOptions<T extends EventTypes = 'click'> {
    /** Indicating that events of this type will be dispatched to the registered listener before being dispatched to any EventTarget beneath it in the DOM tree. */
    capture?: boolean;
    /** A function which receives a notification when an event of the specified type occurs. */
    listener: EventHandler<T>;
    /** A ref object with a target node. */
    targetRef: TargetRef;
    /** A case-sensitive string representing the event type to listen for. */
    type: T;
}
export declare type EventHandler<T extends EventTypes> = (e: DocumentEventMap[T]) => void;
export declare type EventTypes = keyof DocumentEventMap;
export declare type TargetRef = React.RefObject<Node | Window>;