AlpineHotkeyRecorder

Defined in: types.ts:50

Recording state and controls owned by the containing scope.

Type Parameters

THotkey

THotkey extends Hotkey = Hotkey

Properties

cancelRecording

cancelRecording: () => void;

cancelRecording: () => void;

Defined in: types.ts:62

Stop, clear recorder state, and call onCancel.

Returns

void

commitRecording

commitRecording: () => void;

commitRecording: () => void;

Defined in: types.ts:64

Commit the current steps (multi-step recordings).

Returns

void

isRecording

readonly isRecording: boolean;

readonly isRecording: boolean;

Defined in: types.ts:52

Whether the recorder is listening for a shortcut.

recordedHotkey

readonly recordedHotkey: THotkey | null;

readonly recordedHotkey: THotkey | null;

Defined in: types.ts:56

The last committed hotkey, including brackets for physical codes.

startRecording

startRecording: () => void;

startRecording: () => void;

Defined in: types.ts:58

Start a new recording session.

Returns

void

steps

readonly steps: HotkeySequence;

readonly steps: HotkeySequence;

Defined in: types.ts:54

Chords captured so far in a multi-step recording.

stopRecording

stopRecording: () => void;

stopRecording: () => void;

Defined in: types.ts:60

Stop and clear recorder state without calling onRecord or onCancel.

Returns

void