TanStack
Hotkey Recorder API Reference

SvelteHotkeyRecorder

Interface: SvelteHotkeyRecorder

Defined in: packages/svelte-hotkeys/src/createHotkeyRecorder.svelte.ts:8

Properties

cancelRecording()

ts
cancelRecording: () => void;

Defined in: packages/svelte-hotkeys/src/createHotkeyRecorder.svelte.ts:18

Cancel recording without saving

Returns

void


isRecording

ts
readonly isRecording: boolean;

Defined in: packages/svelte-hotkeys/src/createHotkeyRecorder.svelte.ts:10

Whether recording is currently active


recordedHotkey

ts
readonly recordedHotkey: Hotkey | null;

Defined in: packages/svelte-hotkeys/src/createHotkeyRecorder.svelte.ts:12

The currently recorded hotkey (for live preview)


startRecording()

ts
startRecording: () => void;

Defined in: packages/svelte-hotkeys/src/createHotkeyRecorder.svelte.ts:14

Start recording a new hotkey

Returns

void


stopRecording()

ts
stopRecording: () => void;

Defined in: packages/svelte-hotkeys/src/createHotkeyRecorder.svelte.ts:16

Stop recording (same as cancel)

Returns

void