AppHotkey

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 extends string = string

readonly ~appHotkey: true;

Brand that distinguishes app hotkeys from raw hotkey objects.

readonly optional context?: string;

readonly defaultHotkey: TDefault;

Hotkey declared in defineAppHotkeys.

readonly hotkey: Hotkey | null;

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

readonly id: TId;

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

readonly optional meta?: HotkeyMeta;

readonly optional options?: AppHotkeyOptions;