AppHotkey

Defined in: app-hotkeys.ts:72

A declared app hotkey. It never holds a callback: register it with useHotkey(appHotkey, callback) or the equivalent adapter API.

TDefault is the kind of the declared default (HotkeyChord, HotkeySequence, or null). Adapters use it to type kind-specific options.

Type Parameters#

TId#

TId extends string = string

TDefault#

TDefault extends | HotkeyChord | HotkeySequence | null = | HotkeyChord | HotkeySequence | null

Properties#

~appHotkey#

readonly ~appHotkey: true;

Defined in: app-hotkeys.ts:78

Brand that distinguishes app hotkeys from raw hotkey objects.

defaultHotkey#

readonly defaultHotkey: TDefault;

Defined in: app-hotkeys.ts:84

Hotkey declared in defineAppHotkeys.

hotkey#

readonly hotkey: Hotkey | null;

Defined in: app-hotkeys.ts:82

Effective hotkey: the user's custom hotkey, or the default. null means unbound.

id#

readonly id: TId;

Defined in: app-hotkeys.ts:80

Stable id. Saved custom hotkeys are keyed by this value.

meta?#

readonly optional meta?: HotkeyMeta;

Defined in: app-hotkeys.ts:85

options?#

readonly optional options?: AppHotkeyOptions;

Defined in: app-hotkeys.ts:87

scope?#

readonly optional scope?: string;

Defined in: app-hotkeys.ts:86