useHotkey API

API reference for the useHotkey composable.

Functions

(keys: MaybeRefOrGetter<string>, callback: (e: KeyboardEvent) => void, options?: UseHotkeyOptions, _platform?: PlatformContext) => UseHotkeyReturn

A composable that listens for hotkey combinations and sequences.

MaybeRefOrGetter<"keydown" | "keyup">

The keyboard event type to listen for.

Default: 'keydown'

MaybeRefOrGetter<boolean>

Whether to trigger the callback when an input element is focused.

Default: false

MaybeRefOrGetter<boolean>

Whether to prevent the default browser action.

Default: true

MaybeRefOrGetter<boolean>

Whether to stop event propagation.

Default: false

MaybeRefOrGetter<number>

Timeout in ms before a key sequence resets.

Default: 1000

Readonly<Ref<boolean, boolean>>

Whether the hotkey listener is currently active (listening for keys). False when paused, when keys is undefined, or in SSR.

Readonly<Ref<boolean, boolean>>

Whether the hotkey listener is currently paused.

() => void

Pause listening (removes listener but keeps configuration).

() => void

Resume listening after pause.

() => void

Stop listening and clean up (removes listener).