HotkeyRecorderOptions

Defined in: hotkey-recorder.ts:33

Options for configuring a HotkeyRecorder instance.

Extends#

• RecorderOptions

Properties#

detectConflicts?#

optional detectConflicts: boolean | HotkeyConflictOptions;

Defined in: recorder-options.ts:21

Opt in to live-registry conflicts, including sequence prefixes. Default: false.

Inherited from#

RecorderOptions.detectConflicts

ignoreInputs?#

optional ignoreInputs: boolean;

Defined in: hotkey-recorder.ts:52

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:42

Optional callback when recording is cancelled (Escape pressed)

Returns#

void

onClear()?#

optional onClear: () => void;

Defined in: hotkey-recorder.ts:44

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

Returns#

void

onRecord()#

onRecord: (hotkey) => void;

Defined in: hotkey-recorder.ts:40

Callback when a hotkey is successfully recorded

Parameters#

hotkey#

Hotkey

Returns#

void

onReject()?#

optional onReject: (rejection) => void;

Defined in: recorder-options.ts:23

Rejected candidates leave recording active.

Parameters#

rejection#

RecorderRejection

Returns#

void

Inherited from#

RecorderOptions.onReject

platform?#

optional platform: "mac" | "windows" | "linux";

Defined in: recorder-options.ts:19

Platform used for Mod and AltGraph handling. Defaults to platform detection.

Inherited from#

RecorderOptions.platform

recordBy?#

optional recordBy: RecorderKeyMode;

Defined in: recorder-options.ts:17

Physical code recording is the default. Choose key to record logical characters.

Inherited from#

RecorderOptions.recordBy

validate()?#

optional validate: (hotkey, context) => string | boolean;

Defined in: hotkey-recorder.ts:35

Return true to accept, or false/a message to reject while staying in recording mode.

Parameters#

hotkey#

Hotkey

context#

HotkeyRecorderValidationContext

Returns#

string | boolean