Class: HotkeySequenceRecorder

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

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;

new HotkeySequenceRecorder(options): HotkeySequenceRecorder;

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

Parameters

options

HotkeySequenceRecorderOptions

Returns

HotkeySequenceRecorder

Properties

store

readonly store: Store<HotkeySequenceRecorderState>;

readonly store: Store<HotkeySequenceRecorderState>;

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

Methods

cancel()

cancel(): void;

cancel(): void;

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

Returns

void

commit()

commit(): void;

commit(): void;

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

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

Returns

void

destroy()

destroy(): void;

destroy(): void;

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

Returns

void

setOptions()

setOptions(options): void;

setOptions(options): void;

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

Parameters

options

Partial<HotkeySequenceRecorderOptions>

Returns

void

start()

start(): void;

start(): void;

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

Returns

void

stop()

stop(): void;

stop(): void;

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

Returns

void