EmberHotkeyRecorder

Defined in: packages/ember-hotkeys/src/types.ts:33

Recording state and controls owned by the containing component.

Type Parameters#

THotkey#

THotkey extends Hotkey = Hotkey

Properties#

cancelRecording#

cancelRecording: () => void;

Defined in: packages/ember-hotkeys/src/types.ts:45

Stop, clear recorder state, and call onCancel.

Returns#

void

commitRecording#

commitRecording: () => void;

Defined in: packages/ember-hotkeys/src/types.ts:47

Commit the current steps (multi-step recordings).

Returns#

void

isRecording#

readonly isRecording: boolean;

Defined in: packages/ember-hotkeys/src/types.ts:35

Whether the recorder is listening for a shortcut.

recordedHotkey#

readonly recordedHotkey: THotkey | null;

Defined in: packages/ember-hotkeys/src/types.ts:39

The last committed hotkey, including brackets for physical codes.

startRecording#

startRecording: () => void;

Defined in: packages/ember-hotkeys/src/types.ts:41

Start a new recording session.

Returns#

void

steps#

readonly steps: HotkeySequence;

Defined in: packages/ember-hotkeys/src/types.ts:37

Chords captured so far in a multi-step recording.

stopRecording#

stopRecording: () => void;

Defined in: packages/ember-hotkeys/src/types.ts:43

Stop and clear recorder state without calling onRecord or onCancel.

Returns#

void