Hotkey
Defined in: src/core/hotkeys.ts:46
A registered hotkey (the HotkeyOptions plus assigned id and resolved key).
Extends
Section titled “Extends”Properties
Section titled “Properties”context?
Section titled “context?”
optionalcontext?:string| readonlystring[]
Defined in: src/core/hotkeys.ts:36
App context(s) this hotkey is active in. Omitted means global (active in every context). Matched against HotkeyRegistry.context.
Inherited from
Section titled “Inherited from”description?
Section titled “description?”
optionaldescription?:string
Defined in: src/core/hotkeys.ts:29
One-line explanation shown next to the name.
Inherited from
Section titled “Inherited from”enabled?
Section titled “enabled?”
optionalenabled?: () =>boolean
Defined in: src/core/hotkeys.ts:38
Extra gate evaluated at dispatch and list time (e.g. “has selection”).
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”
readonlygroup:string
Defined in: src/core/hotkeys.ts:54
Resolved group name (defaults to “General”).
Overrides
Section titled “Overrides”handler
Section titled “handler”handler: (
ev) =>void
Defined in: src/core/hotkeys.ts:42
Called when the key is pressed.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”hidden?
Section titled “hidden?”
optionalhidden?:boolean
Defined in: src/core/hotkeys.ts:40
Keep the hotkey functional but omit it from the palette listing.
Inherited from
Section titled “Inherited from”
readonlyid:number
Defined in: src/core/hotkeys.ts:48
Unique registration id.
readonlykey:string
Defined in: src/core/hotkeys.ts:50
Canonical normalized key, e.g. "ctrl+shift+p".
Overrides
Section titled “Overrides”keyLabel
Section titled “keyLabel”
readonlykeyLabel:string
Defined in: src/core/hotkeys.ts:52
Display form of the key, e.g. "Ctrl+Shift+P".
name:
string
Defined in: src/core/hotkeys.ts:27
Short human name shown in the palette, e.g. “Save file”.