useEventListener API
A composable for handling DOM events with automatic cleanup on component unmount.
Related
Explore these related pages for additional context and usage patterns.
| Page | Category |
|---|---|
| useEventListener | System |
| useHotkey | System |
| useClickOutside | System |
Functions
useEventListener
(target: MaybeRefOrGetter<EventTarget | null | undefined>, event: MaybeRefOrGetter<MaybeArray<string>>, listener: MaybeRef<MaybeArray<EventHandler<Event>>>, options?: MaybeRefOrGetter<boolean | AddEventListenerOptions> | undefined) => CleanupFunctionAttaches an event listener to a target.
useWindowEventListener
(event: MaybeRefOrGetter<MaybeArray<E>>, listener: MaybeRef<MaybeArray<(this: Window, event: WindowEventMap[E]) => void>>, options?: MaybeRefOrGetter<boolean | AddEventListenerOptions> | undefined) => CleanupFunctionAttaches an event listener to the window.
useDocumentEventListener
(event: MaybeRefOrGetter<MaybeArray<E>>, listener: MaybeRef<MaybeArray<(this: Document, event: DocumentEventMap[E]) => void>>, options?: MaybeRefOrGetter<boolean | AddEventListenerOptions> | undefined) => CleanupFunctionAttaches an event listener to the document.