Interface: HotkeyRecorderOptions#

Defined in: hotkey-recorder.ts:20

Options for configuring a HotkeyRecorder instance.

Properties#

ignoreInputs?#

optional ignoreInputs: boolean;

Defined in: hotkey-recorder.ts:34

Whether to ignore keyboard events from input-like elements (text inputs, textarea, select, contenteditable). When true, typing in inputs passes through normally instead of being captured as a hotkey recording. Escape always works regardless of this setting.

Default#

true

onCancel()?#

optional onCancel: () => void;

Defined in: hotkey-recorder.ts:24

Optional callback when recording is cancelled (Escape pressed)

Returns#

void

onClear()?#

optional onClear: () => void;

Defined in: hotkey-recorder.ts:26

Optional callback when shortcut is cleared (Backspace/Delete pressed)

Returns#

void

onRecord()#

onRecord: (hotkey) => void;

Defined in: hotkey-recorder.ts:22

Callback when a hotkey is successfully recorded

Parameters#

hotkey#

Hotkey

Returns#

void