Hotkeys API Reference
- HotkeyManager
- getHotkeyManager
- Hotkey
- HotkeyChord
- HotkeySequence
- RegisterableHotkey
- RegisterableHotkeyChord
- RegisterableHotkeySequence
- RawHotkeyChord
- HotkeyOptions
- HotkeyChordOptions
- HotkeySequenceOptions
- HotkeyOptionsFor
- HotkeyRegistrationHandle
- HotkeyRegistrationView
- HotkeyChordRegistrationView
- HotkeySequenceRegistrationView
- toHotkeyRegistrationView
- HotkeyCallback
- HotkeyCallbackContext
- HotkeyChordCallbackContext
- HotkeySequenceCallbackContext
- HotkeyCallbackContextFor
- HotkeyMeta
- ConflictBehavior
- isHotkeySequence
- simplifyHotkey
- createSequenceMatcher
- DEFAULT_SEQUENCE_TIMEOUT
- HotkeysProvider
- useDefaultHotkeysOptions
- useHotkey
- useHotkeyRegistrations
- useHotkeys
- useHotkeysContext
- HotkeysProviderOptions
- HotkeysProviderProps
- UseHotkeyChordOptions
- UseHotkeyCommonOptions
- UseHotkeyDefinition
- UseHotkeyOptions
- UseHotkeyOptionsFor
- UseHotkeySequenceOptions
- UseHotkeyTarget
App Hotkeys API Reference
- defineAppHotkeys
- AppHotkeysStore
- provideAppHotkeys
- publishAppHotkeysStore
- AppHotkey
- AppHotkeyInput
- AppHotkeyOptions
- AppHotkeyListItem
- AppHotkeyStatus
- AppHotkeysState
- AppHotkeysStoreOptions
- CustomHotkeys
- Register
- AppHotkeyId
- RegisteredAppHotkeys
- isAppHotkey
- isCustomHotkey
- resolveAppHotkey
- useAppHotkeyList
- useAppHotkeys
- useCustomHotkeys
- UseCustomHotkeysResult
- UseAppHotkeyOptions
Key hold & held keys API Reference
Hotkey Recorder API Reference
- HotkeyRecorder
- HotkeyRecorderOptions
- HotkeyChordRecorderOptions
- HotkeySequenceRecorderOptions
- HotkeyRecorderState
- HotkeyRecorderCommitKeys
- HotkeyRecorderValidationContext
- HotkeyChordRecorderValidationContext
- HotkeySequenceRecorderValidationContext
- RecorderOptions
- RecorderRejection
- RecorderKeyMode
- findHotkeyConflicts
- HotkeyConflict
- HotkeyConflictOptions
- useHotkeyRecorder
- ReactHotkeyRecorder
Normalization & format API Reference
- formatForDisplay
- FormatDisplayOptions
- DisplayHotkey
- DisplayHotkeyChord
- formatHotkey
- normalizeHotkey
- parseHotkey
- parseKeyboardEvent
- ParsedHotkeyChord
- matchesKeyboardEvent
- areHotkeysEqual
- validateHotkey
- checkHotkey
- assertValidHotkey
- ValidationResult
- ValidatableHotkey
- LogicalKey
- PhysicalKey
- PhysicalKeyCode
- KEY_DISPLAY_SYMBOLS
- PUNCTUATION_KEY_DISPLAY_LABELS
- MAC_MODIFIER_SYMBOLS
- MAC_MODIFIER_LABELS
- WINDOWS_MODIFIER_LABELS
- LINUX_MODIFIER_LABELS
- MODIFIER_ALIASES
- MODIFIER_ORDER
- MODIFIER_KEYS
HotkeyChordRegistration
Defined in: hotkey-manager.ts:154
A registered chord in the HotkeyManager.
Extends#
- RegistrationBase<HotkeyChordOptions>
Properties#
activeMatch?#
optional activeMatch?: object;Defined in: hotkey-manager.ts:159
The concrete key/code that activated a requireReset registration.
code#
code: string;key#
key: string;callback#
callback: HotkeyCallback;Defined in: hotkey-manager.ts:142
The callback to invoke
Inherited from#
RegistrationBase.callbackhasFired#
hasFired: boolean;Defined in: hotkey-manager.ts:150
Whether this registration has fired (and, for requireReset chords, needs a reset)
Inherited from#
RegistrationBase.hasFiredhotkey#
hotkey: HotkeyChord;Defined in: hotkey-manager.ts:156
id#
id: string;Defined in: hotkey-manager.ts:140
Unique identifier for this registration
Inherited from#
RegistrationBase.idkind#
kind: "chord";Defined in: hotkey-manager.ts:155
options#
options: HotkeyChordOptions;Defined in: hotkey-manager.ts:144
Resolved options for this registration
Inherited from#
RegistrationBase.optionsparsedChord#
parsedChord: ParsedHotkeyChord;Defined in: hotkey-manager.ts:157
target#
target: Target;Defined in: hotkey-manager.ts:146
The resolved target element for this registration
Inherited from#
RegistrationBase.targettriggerCount#
triggerCount: number;Defined in: hotkey-manager.ts:148
How many times this registration's callback has been triggered
Inherited from#
RegistrationBase.triggerCount