OctaneHotkeyRecorder

Defined in: types.ts:11

Recording state and controls owned by the containing component.

Type Parameters

THotkey

THotkey extends Hotkey = Hotkey

Properties

cancelRecording

cancelRecording: () => void;

cancelRecording: () => void;

Defined in: types.ts:23

Stop, clear recorder state, and call onCancel.

Returns

void

commitRecording

commitRecording: () => void;

commitRecording: () => void;

Defined in: types.ts:25

Commit the current steps (multi-step recordings).

Returns

void

isRecording

isRecording: boolean;

isRecording: boolean;

Defined in: types.ts:13

Whether the recorder is listening for a shortcut.

recordedHotkey

recordedHotkey: THotkey | null;

recordedHotkey: THotkey | null;

Defined in: types.ts:17

The last committed hotkey, including brackets for physical codes.

startRecording

startRecording: () => void;

startRecording: () => void;

Defined in: types.ts:19

Start a new recording session.

Returns

void

steps

steps: HotkeySequence;

steps: HotkeySequence;

Defined in: types.ts:15

Chords captured so far in a multi-step recording.

stopRecording

stopRecording: () => void;

stopRecording: () => void;

Defined in: types.ts:21

Stop and clear recorder state without calling onRecord or onCancel.

Returns

void