EmberHotkeysScope

Defined in: packages/ember-hotkeys/src/createHotkeysScope.ts:12

Helpers, modifiers, and recorder factories with shared defaults. Owners retain their own cleanup.

Properties#

onHotkey#

onHotkey: typeof onHotkey;

Defined in: packages/ember-hotkeys/src/createHotkeysScope.ts:13

onHotkeys#

onHotkeys: typeof onHotkeys;

Defined in: packages/ember-hotkeys/src/createHotkeysScope.ts:14

useHotkey#

useHotkey: typeof useHotkey;

Defined in: packages/ember-hotkeys/src/createHotkeysScope.ts:15

useHotkeyRecorder#

useHotkeyRecorder: {
  (owner, options): EmberHotkeyRecorder<HotkeyChord>;
  (owner, options): EmberHotkeyRecorder;
  (owner, options): EmberHotkeyRecorder;
  (owner, options): EmberHotkeyRecorder<HotkeyChord>;
  (owner, options): EmberHotkeyRecorder;
};

Defined in: packages/ember-hotkeys/src/createHotkeysScope.ts:17

Call Signature#

(owner, options): EmberHotkeyRecorder<HotkeyChord>;

Creates an owned recorder with autotracked state and current callback options. With the default maxSteps: 1, the first valid chord is recorded. With a larger maxSteps, each chord adds a step; the recording commits on Enter (unless commitKeys: 'none'), after idleTimeoutMs, or at maxSteps, and onRecord receives a chord (one step) or a sequence.

Parameters#

owner#

object

options#

HotkeyChordRecorderOptions

Returns#

EmberHotkeyRecorder<HotkeyChord>

Call Signature#

(owner, options): EmberHotkeyRecorder;

Creates an owned recorder with autotracked state and current callback options. With the default maxSteps: 1, the first valid chord is recorded. With a larger maxSteps, each chord adds a step; the recording commits on Enter (unless commitKeys: 'none'), after idleTimeoutMs, or at maxSteps, and onRecord receives a chord (one step) or a sequence.

Parameters#

owner#

object

options#

HotkeySequenceRecorderOptions

Returns#

EmberHotkeyRecorder

Call Signature#

(owner, options): EmberHotkeyRecorder;

Creates an owned recorder with autotracked state and current callback options. With the default maxSteps: 1, the first valid chord is recorded. With a larger maxSteps, each chord adds a step; the recording commits on Enter (unless commitKeys: 'none'), after idleTimeoutMs, or at maxSteps, and onRecord receives a chord (one step) or a sequence.

Parameters#

owner#

object

options#

() => HotkeySequenceRecorderOptions

Returns#

EmberHotkeyRecorder

Call Signature#

(owner, options): EmberHotkeyRecorder<HotkeyChord>;

Creates an owned recorder with autotracked state and current callback options. With the default maxSteps: 1, the first valid chord is recorded. With a larger maxSteps, each chord adds a step; the recording commits on Enter (unless commitKeys: 'none'), after idleTimeoutMs, or at maxSteps, and onRecord receives a chord (one step) or a sequence.

Parameters#

owner#

object

options#

() => HotkeyChordRecorderOptions

Returns#

EmberHotkeyRecorder<HotkeyChord>

Call Signature#

(owner, options): EmberHotkeyRecorder;

Creates an owned recorder with autotracked state and current callback options. With the default maxSteps: 1, the first valid chord is recorded. With a larger maxSteps, each chord adds a step; the recording commits on Enter (unless commitKeys: 'none'), after idleTimeoutMs, or at maxSteps, and onRecord receives a chord (one step) or a sequence.

Parameters#

owner#

object

options#

() => HotkeyRecorderOptions

Returns#

EmberHotkeyRecorder

useHotkeys#

useHotkeys: typeof useHotkeys;

Defined in: packages/ember-hotkeys/src/createHotkeysScope.ts:16