Docs
CodeRabbit
Cloudflare
AG Grid
SerpAPI
Netlify
OpenRouter
Neon
WorkOS
Clerk
Electric
PowerSync
Sentry
Railway
Prisma
Strapi
Unkey
CodeRabbit
Cloudflare
AG Grid
SerpAPI
Netlify
OpenRouter
Neon
WorkOS
Clerk
Electric
PowerSync
Sentry
Railway
Prisma
Strapi
Unkey
API Reference
Hotkeys API Reference
Hotkey Sequence API Reference
Key hold & held keys API Reference
Hotkey Recorder API Reference
Hotkey Sequence Recorder API Reference
Normalization & format API Reference
Hotkey Sequence Recorder API Reference

HotkeySequenceRecorder

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

ts
new HotkeySequenceRecorder(options): HotkeySequenceRecorder;

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

Parameters

options

HotkeySequenceRecorderOptions

Returns

HotkeySequenceRecorder

Properties

store

ts
readonly store: Store<HotkeySequenceRecorderState>;

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

Methods

cancel()

ts
cancel(): void;

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

Returns

void


commit()

ts
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()

ts
destroy(): void;

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

Returns

void


setOptions()

ts
setOptions(options): void;

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

Parameters

options

Partial<HotkeySequenceRecorderOptions>

Returns

void


start()

ts
start(): void;

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

Returns

void


stop()

ts
stop(): void;

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

Returns

void