Hotkeys Docs
API Reference
Hotkeys API Reference
- HotkeyManager
- getHotkeyManager
- Hotkey
- HotkeyChord
- HotkeySequence
- RegisterableHotkey
- RegisterableHotkeyChord
- RawHotkey
- HotkeyOptions
- HotkeyChordOptions
- HotkeySequenceOptions
- HotkeyOptionsFor
- HotkeyRegistrationHandle
- HotkeyRegistrationView
- HotkeyChordRegistrationView
- HotkeySequenceRegistrationView
- toHotkeyRegistrationView
- HotkeyCallback
- HotkeyCallbackContext
- 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
- RecorderOptions
- RecorderRejection
- RecorderKeyMode
- findHotkeyConflicts
- HotkeyConflict
- HotkeyConflictOptions
- useHotkeyRecorder
- ReactHotkeyRecorder
Normalization & format API Reference
- formatForDisplay
- FormatDisplayOptions
- DisplayHotkey
- DisplayHotkeyChord
- formatHotkey
- normalizeHotkey
- normalizeHotkeyFromParsed
- normalizeHotkeyFromEvent
- normalizeRegisterableHotkey
- parseHotkey
- parseRegisterableHotkey
- parseKeyboardEvent
- rawHotkeyToParsedHotkey
- ParsedHotkey
- 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
AI/LLM: This documentation page is available in plain markdown format at/hotkeys/latest/docs/reference/variables/KEY_DISPLAY_SYMBOLS.md
Normalization & format API Reference
KEY_DISPLAY_SYMBOLS
ts
const KEY_DISPLAY_SYMBOLS: object;Defined in: display-labels.ts:112
Special key symbols for display formatting.
Maps certain keys to their visual symbols for better readability in hotkey displays. Used by formatting functions to show symbols like ↑ for ArrowUp or ↵ for Enter instead of text labels.
Type Declaration#
ArrowDown#
ts
readonly ArrowDown: "↓" = '↓';ArrowLeft#
ts
readonly ArrowLeft: "←" = '←';ArrowRight#
ts
readonly ArrowRight: "→" = '→';ArrowUp#
ts
readonly ArrowUp: "↑" = '↑';Backspace#
ts
readonly Backspace: "⌫" = '⌫';Delete#
ts
readonly Delete: "⌦" = '⌦';Enter#
ts
readonly Enter: "↵" = '↵';Escape#
ts
readonly Escape: "Esc" = 'Esc';Space#
ts
readonly Space: "␣" = '␣';Tab#
ts
readonly Tab: "⇥" = '⇥';Example#
ts
KEY_DISPLAY_SYMBOLS['ArrowUp'] // '↑'
KEY_DISPLAY_SYMBOLS['Enter'] // '↵'
KEY_DISPLAY_SYMBOLS['Escape'] // 'Esc'
KEY_DISPLAY_SYMBOLS['Space'] // '␣'