SolidHotkeyRecorder | TanStack Hotkeys Solid Docs

Type Parameters

THotkey extends Hotkey = Hotkey

cancelRecording: () => void;

cancelRecording: () => void;

Cancel recording and call onCancel

void

commitRecording: () => void;

commitRecording: () => void;

Commit the recorded steps now (multi-step recordings)

void

isRecording: () => boolean;

isRecording: () => boolean;

Whether recording is currently active

boolean

recordedHotkey: () => THotkey | null;

recordedHotkey: () => THotkey | null;

The last committed hotkey

THotkey | null

startRecording: () => void;

startRecording: () => void;

Start recording a new hotkey

void

steps: () => HotkeySequence;

steps: () => HotkeySequence;

Chords recorded so far in a multi-step recording (for live preview)

HotkeySequence

stopRecording: () => void;

stopRecording: () => void;

Stop recording without calling onCancel

void