HotkeySequenceRecorder

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

Framework-agnostic class for recording multi-chord sequences (Vim-style shortcuts).

Each step is captured like a single hotkey chord. Press Enter (no modifiers) to commit when HotkeySequenceRecorderOptions.commitKeys is 'enter' (default), Escape to cancel, Backspace/Delete to remove the last step or clear when empty.

Constructors#

Constructor#

new HotkeySequenceRecorder(options): HotkeySequenceRecorder;

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

Options may be a getter to read current configuration during an active session.

Parameters#

options#

| HotkeySequenceRecorderOptions | (() => HotkeySequenceRecorderOptions)

Returns#

HotkeySequenceRecorder

Properties#

store#

readonly store: Store<HotkeySequenceRecorderState>;

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

Methods#

cancel()#

cancel(): void;

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

Stops, discards in-progress steps, and notifies onCancel.

Returns#

void

commit()#

commit(): void;

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

Commit the current steps as a sequence. No-op if fewer than one step.

Returns#

void

destroy()#

destroy(): void;

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

Returns#

void

setOptions()#

setOptions(options): void;

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

Merges current callbacks and options without discarding recorded steps.

Parameters#

options#

Partial<HotkeySequenceRecorderOptions>

Returns#

void

start()#

start(): void;

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

Starts a fresh recording; repeated starts during an active session are ignored.

Returns#

void

stop()#

stop(): void;

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

Stops and discards in-progress steps without invoking onCancel.

Returns#

void