Hotkeys API Reference

CreateHotkeyOptions

Interface: CreateHotkeyOptions

Defined in: createHotkey.ts:17

Extends

  • Omit<HotkeyOptions, "target">

Properties

target?

ts
optional target: HTMLElement | Document | Window | null;

Defined in: createHotkey.ts:25

The DOM element to attach the event listener to. Can be a direct DOM element, an accessor (for reactive targets that become available after mount), or null. Defaults to document. When using scoped targets, pass an accessor: () => ({ target: elementSignal() }) so the hotkey waits for the element to be attached before registering.