TanStack
Hotkey Recorder API Reference

VueHotkeyRecorder

Interface: VueHotkeyRecorder

Defined in: packages/vue-hotkeys/src/useHotkeyRecorder.ts:8

Properties

cancelRecording()

ts
cancelRecording: () => void;

Defined in: packages/vue-hotkeys/src/useHotkeyRecorder.ts:18

Cancel recording without saving

Returns

void


isRecording

ts
isRecording: Ref<boolean>;

Defined in: packages/vue-hotkeys/src/useHotkeyRecorder.ts:10

Whether recording is currently active


recordedHotkey

ts
recordedHotkey: Ref<Hotkey | null>;

Defined in: packages/vue-hotkeys/src/useHotkeyRecorder.ts:12

The currently recorded hotkey (for live preview)


startRecording()

ts
startRecording: () => void;

Defined in: packages/vue-hotkeys/src/useHotkeyRecorder.ts:14

Start recording a new hotkey

Returns

void


stopRecording()

ts
stopRecording: () => void;

Defined in: packages/vue-hotkeys/src/useHotkeyRecorder.ts:16

Stop recording (same as cancel)

Returns

void