Skip to main content

Interface: UseEventListener()

Defined in: use-event-listener.ts:11

Call signatures of useEventListener.

Call Signature​

UseEventListener<K>(type, handler, target?, options?): void

Defined in: use-event-listener.ts:13

Listen on window (the default when no target is given).

Type Parameters​

K​

K extends keyof WindowEventMap

Parameters​

type​

K

handler​

(event) => void

target?​

EventListenerTarget<Window>

options?​

AddEventListenerOptions

Returns​

void

Call Signature​

UseEventListener<K>(type, handler, target, options?): void

Defined in: use-event-listener.ts:20

Listen on document.

Type Parameters​

K​

K extends keyof DocumentEventMap

Parameters​

type​

K

handler​

(event) => void

target​

EventListenerTarget<Document>

options?​

AddEventListenerOptions

Returns​

void

Call Signature​

UseEventListener<K, T>(type, handler, target, options?): void

Defined in: use-event-listener.ts:27

Listen on an HTML element, or a ref to one.

Type Parameters​

K​

K extends keyof HTMLElementEventMap

T​

T extends HTMLElement = HTMLElement

Parameters​

type​

K

handler​

(event) => void

target​

EventListenerTarget<T>

options?​

AddEventListenerOptions

Returns​

void

Call Signature​

UseEventListener<E>(type, handler, target, options?): void

Defined in: use-event-listener.ts:34

Listen for any event on any EventTarget (custom events, MediaQueryList, ...).

Type Parameters​

E​

E extends Event = Event

Parameters​

type​

string

handler​

(event) => void

target​

EventListenerTarget<EventTarget>

options?​

AddEventListenerOptions

Returns​

void