Skip to content
aq-ui
Back to HooksHook

Use Event Listener

Open-code aq-ui React hook for Use Event Listener.

Installation

pnpm dlx aq-ui@alpha add use-event-listener

API reference

Client module

Import the parts you need, then jump to an export for its contract.

View full source

Quick start

"use client"

import { useEventListener } from "@/hooks/use-event-listener"

EventListenerOptions

interfaceSource L8

Type contract for EventListenerOptions.

interface EventListenerOptions extends AddEventListenerOptions

Members

NameTypeDefault
enabled?booleantrue

useEventListener

functionSource L12

Open-code aq-ui React hook for Use Event Listener.

function useEventListener<TEvent extends Event>(target: Target<EventTarget> | undefined, eventName: string, handler: (event: TEvent) => void, { enabled = true, capture, once, passive, signal }: EventListenerOptions = {}): void
Returns
void

Parameters

NameTypeDefault
targetTarget<EventTarget> | undefined—
eventNamestring—
handler(event: TEvent) => void—
options?EventListenerOptions{}

Registry dependencies

hook-target, use-stable-callback

Files

  • hooks/use-event-listener.ts

Source