ReactHotkeyRecorder

Defined in: useHotkeyRecorder.ts:17

Type Parameters#

THotkey#

THotkey extends Hotkey = Hotkey

Properties#

cancelRecording#

cancelRecording: () => void;

Defined in: useHotkeyRecorder.ts:29

Cancel recording and call onCancel

Returns#

void

commitRecording#

commitRecording: () => void;

Defined in: useHotkeyRecorder.ts:31

Commit the recorded steps now (multi-step recordings)

Returns#

void

isRecording#

isRecording: boolean;

Defined in: useHotkeyRecorder.ts:19

Whether recording is currently active

recordedHotkey#

recordedHotkey: THotkey | null;

Defined in: useHotkeyRecorder.ts:23

The last committed hotkey

startRecording#

startRecording: () => void;

Defined in: useHotkeyRecorder.ts:25

Start recording a new hotkey

Returns#

void

steps#

steps: HotkeySequence;

Defined in: useHotkeyRecorder.ts:21

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

stopRecording#

stopRecording: () => void;

Defined in: useHotkeyRecorder.ts:27

Stop recording without calling onCancel

Returns#

void