Interface: HotkeySequenceRecorderOptions

Defined in: hotkey-sequence-recorder.ts:29

Options for configuring a HotkeySequenceRecorder instance.

Properties

commitKeys?

optional commitKeys: HotkeySequenceRecorderCommitKeys;

optional commitKeys: HotkeySequenceRecorderCommitKeys;

Defined in: hotkey-sequence-recorder.ts:45

Keyboard commit mode. When 'none', use HotkeySequenceRecorder.commit (and optional idle timeout).

Default

'enter'

'enter'

commitOnEnter?

optional commitOnEnter: boolean;

optional commitOnEnter: boolean;

Defined in: hotkey-sequence-recorder.ts:40

Whether plain Enter commits the current steps. Ignored when commitKeys is 'none'.

Default

true

true

idleTimeoutMs?

optional idleTimeoutMs: number;

optional idleTimeoutMs: number;

Defined in: hotkey-sequence-recorder.ts:50

Milliseconds of inactivity after the last completed chord before auto-committing. The timer does not run while waiting for the first chord (steps.length === 0).

ignoreInputs?

optional ignoreInputs: boolean;

optional ignoreInputs: boolean;

Defined in: hotkey-sequence-recorder.ts:58

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 sequence recording. Escape always works regardless of this setting.

Default

true

true

onCancel()?

optional onCancel: () => void;

optional onCancel: () => void;

Defined in: hotkey-sequence-recorder.ts:33

Optional callback when recording is cancelled (Escape pressed)

Returns

void

onClear()?

optional onClear: () => void;

optional onClear: () => void;

Defined in: hotkey-sequence-recorder.ts:35

Optional callback when the sequence is cleared (Backspace/Delete with no steps)

Returns

void

onRecord()

onRecord: (sequence) => void;

onRecord: (sequence) => void;

Defined in: hotkey-sequence-recorder.ts:31

Callback when a sequence is successfully recorded (including empty array when cleared)

Parameters

sequence

HotkeySequence

Returns

void