TanStack
Hotkey Sequence Recorder API Reference

AlpineHotkeySequenceRecorder

Defined in: types.ts:40

Sequence recording state and controls.

Properties

cancelRecording

ts
cancelRecording: () => void;

Defined in: types.ts:52

Discard the current session and call onCancel.

Returns

void


commitRecording

ts
commitRecording: () => void;

Defined in: types.ts:54

Commit the current steps. Does nothing when no steps are recorded.

Returns

void


isRecording

ts
readonly isRecording: boolean;

Defined in: types.ts:42

Whether the recorder is listening for chords.


recordedSequence

ts
readonly recordedSequence: HotkeySequence | null;

Defined in: types.ts:46

The last committed sequence.


startRecording

ts
startRecording: () => void;

Defined in: types.ts:48

Start a new recording session.

Returns

void


steps

ts
readonly steps: HotkeySequence;

Defined in: types.ts:44

Chords captured in the current session.


stopRecording

ts
stopRecording: () => void;

Defined in: types.ts:50

Stop without committing or calling onCancel.

Returns

void