Hotkeys API Reference
- HotkeyManager
- getHotkeyManager
- HotkeyScopesState
- Hotkey
- HotkeyChord
- HotkeySequence
- RegisterableHotkey
- RegisterableHotkeyChord
- RegisterableHotkeySequence
- RawHotkeyChord
- HotkeyOptions
- HotkeyChordOptions
- HotkeySequenceOptions
- HotkeyOptionsFor
- HotkeyRegistrationHandle
- HotkeyRegistrationView
- HotkeyChordRegistrationView
- HotkeySequenceRegistrationView
- HotkeyRegistrationStatus
- toHotkeyRegistrationView
- HotkeyCallback
- HotkeyCallbackContext
- HotkeyChordCallbackContext
- HotkeySequenceCallbackContext
- HotkeyCallbackContextFor
- HotkeyMeta
- ConflictBehavior
- isHotkeySequence
- simplifyHotkey
- createSequenceMatcher
- DEFAULT_SEQUENCE_TIMEOUT
- createHotkeyRecorder
- createHotkeysScope
- hotkeyRecorderPlugin
- hotkeysPlugin
- AlpineCreateHotkey
- AlpineHotkeys
- AlpineHotkeyState
- DefaultHotkeysOptions
- HotkeyRegistrationsResult
- AlpineHotkeyCommonOptions
- AlpineHotkeyDefinition
- AlpineHotkeyOptionsFor
- AlpineHotkeyTarget
- MaybeGetter
App Hotkeys API Reference
- defineAppHotkeys
- AppHotkeysStore
- installAppHotkeysStore
- provideAppHotkeys
- publishAppHotkeysStore
- AppHotkey
- AppHotkeyInput
- AppHotkeyOptions
- AppHotkeyListItem
- AppHotkeyStatus
- AppHotkeysState
- AppHotkeysStoreOptions
- CustomHotkeys
- Register
- AppHotkeyId
- RegisteredAppHotkeys
- isAppHotkey
- isCustomHotkey
- resolveAppHotkey
- AlpineCustomHotkeys
- AlpineAppHotkeyOptions
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
- AlpineCreateHotkeyRecorder
- AlpineHotkeyRecorder
Normalization & format API Reference
- formatForDisplay
- FormatDisplayOptions
- DisplayHotkey
- DisplayHotkeyChord
- detectPlatform
- HotkeyPlatform
- 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
DefaultHotkeysOptions
Defined in: types.ts:205
Shared defaults; call-specific options take precedence.
Properties#
hotkey?#
optional hotkey?: AlpineHotkeyCommonOptions;Defined in: types.ts:221
Defaults for every hotkey. requireReset applies to chords and timeout to sequences.
hotkeyRecorder?#
optional hotkeyRecorder?: Partial<Omit<HotkeyChordRecorderOptions & HotkeySequenceRecorderOptions, "maxSteps" | "validate" | "onRecord">>;Defined in: types.ts:223
Defaults for every recorder.
keyboardLayout?#
optional keyboardLayout?: boolean;Defined in: types.ts:219
Whether labels from createFormatForDisplay follow the user's keyboard layout, so [KeyQ] reads A on a French AZERTY keyboard. The layout loads from the browser when the first createFormatForDisplay or createKeyboardLayout runs. Only Chromium browsers report one. Set false to never ask the browser for it. Default: true.
platform?#
optional platform?: HotkeyPlatform;Defined in: types.ts:211
The user's platform, for labels from createFormatForDisplay, hotkeys, and recorders. hotkey.platform and hotkeyRecorder.platform win. Detected when unset.