SolidHotkeyRecorder

Defined in: createHotkeyRecorder.ts:14

Type Parameters#

THotkey#

THotkey extends Hotkey = Hotkey

Properties#

cancelRecording#

cancelRecording: () => void;

Defined in: createHotkeyRecorder.ts:26

Cancel recording and call onCancel

Returns#

void

commitRecording#

commitRecording: () => void;

Defined in: createHotkeyRecorder.ts:28

Commit the recorded steps now (multi-step recordings)

Returns#

void

isRecording#

isRecording: () => boolean;

Defined in: createHotkeyRecorder.ts:16

Whether recording is currently active

Returns#

boolean

recordedHotkey#

recordedHotkey: () => THotkey | null;

Defined in: createHotkeyRecorder.ts:20

The last committed hotkey

Returns#

THotkey | null

startRecording#

startRecording: () => void;

Defined in: createHotkeyRecorder.ts:22

Start recording a new hotkey

Returns#

void

steps#

steps: () => HotkeySequence;

Defined in: createHotkeyRecorder.ts:18

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

Returns#

HotkeySequence

stopRecording#

stopRecording: () => void;

Defined in: createHotkeyRecorder.ts:24

Stop recording without calling onCancel

Returns#

void