HotkeyChordRecorderOptions

Defined in: hotkey-recorder.ts:146

Options for recording a single chord. This is the default (maxSteps: 1).

Extends#

• HotkeyRecorderBaseOptions

Properties#

detectConflicts?#

optional detectConflicts?: boolean | HotkeyConflictOptions;

Defined in: hotkey-recorder.ts:76

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

Inherited from#

HotkeyRecorderBaseOptions.detectConflicts

ignoreInputs?#

optional ignoreInputs?: boolean;

Defined in: hotkey-recorder.ts:135

Whether to ignore keyboard events from input-like elements (text inputs, textarea, select, contenteditable) while recording. When true, typing in inputs passes through normally (Escape still cancels). Defaults to true.

Inherited from#

HotkeyRecorderBaseOptions.ignoreInputs

maxSteps?#

optional maxSteps?: 1;

Defined in: hotkey-recorder.ts:148

Maximum number of chords to record. Default: 1

onCancel?#

optional onCancel?: () => void;

Defined in: hotkey-recorder.ts:124

Optional callback when recording is cancelled: Escape, or Tab without recordTab

Returns#

void

Inherited from#

HotkeyRecorderBaseOptions.onCancel

onClear?#

optional onClear?: () => void;

Defined in: hotkey-recorder.ts:129

Optional callback when the recording is cleared: Backspace/Delete with no modifiers and no recorded steps

Returns#

void

Inherited from#

HotkeyRecorderBaseOptions.onClear

onRecord#

onRecord: (hotkey, context) => void;

Defined in: hotkey-recorder.ts:158

Callback when a chord is successfully recorded. context is the one validate received, with the key press that recorded the chord.

Parameters#

hotkey#

HotkeyChord

context#

HotkeyChordRecorderValidationContext

Returns#

void

onReject?#

optional onReject?: (rejection) => void;

Defined in: hotkey-recorder.ts:78

Rejected candidates leave recording active.

Parameters#

rejection#

RecorderRejection

Returns#

void

Inherited from#

HotkeyRecorderBaseOptions.onReject

platform?#

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

Defined in: hotkey-recorder.ts:74

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

Inherited from#

HotkeyRecorderBaseOptions.platform

recordBy?#

optional recordBy?: RecorderKeyMode;

Defined in: hotkey-recorder.ts:72

How the pressed key is written. Default: 'auto'.

Inherited from#

HotkeyRecorderBaseOptions.recordBy

recordTab?#

optional recordTab?: boolean;

Defined in: hotkey-recorder.ts:142

Whether to record Tab and Shift+Tab. By default they cancel recording and move focus, so keyboard users can leave the recorder. Tab with Control, Alt, or Meta isn't affected. When true, tell users that Escape cancels. Default: false

Inherited from#

HotkeyRecorderBaseOptions.recordTab

validate?#

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

Defined in: hotkey-recorder.ts:150

Return true to accept, or false or a message to reject while staying in recording mode. The message is passed to onReject.

Parameters#

hotkey#

HotkeyChord

context#

HotkeyChordRecorderValidationContext

Returns#

string | boolean