TanStack
Hotkey Recorder API Reference

SolidHotkeyRecorder

Defined in: createHotkeyRecorder.ts:7

Properties

cancelRecording

ts
cancelRecording: () => void;

Defined in: createHotkeyRecorder.ts:17

Cancel recording without saving

Returns

void


isRecording

ts
isRecording: () => boolean;

Defined in: createHotkeyRecorder.ts:9

Whether recording is currently active

Returns

boolean


recordedHotkey

ts
recordedHotkey: () => Hotkey | null;

Defined in: createHotkeyRecorder.ts:11

The currently recorded hotkey (for live preview)

Returns

Hotkey | null


startRecording

ts
startRecording: () => void;

Defined in: createHotkeyRecorder.ts:13

Start recording a new hotkey

Returns

void


stopRecording

ts
stopRecording: () => void;

Defined in: createHotkeyRecorder.ts:15

Stop recording (same as cancel)

Returns

void