TanStack
Hotkey Recorder API Reference

SolidHotkeyRecorder

Defined in: createHotkeyRecorder.ts:17

Extends

  • HotkeyRecorderActions

Type Parameters

THotkey

THotkey extends Hotkey = Hotkey

Properties

isRecording

ts
isRecording: () => boolean;

Defined in: createHotkeyRecorder.ts:21

Whether recording is currently active

Returns

boolean


recordedHotkey

ts
recordedHotkey: () => THotkey | null;

Defined in: createHotkeyRecorder.ts:25

The last committed hotkey

Returns

THotkey | null


steps

ts
steps: () => HotkeySequence;

Defined in: createHotkeyRecorder.ts:23

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

Returns

HotkeySequence