Hotkeys Docs
API Reference
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
AI/LLM: This documentation page is available in plain markdown format at/hotkeys/latest/docs/reference/type-aliases/PhysicalKeyCode.md
Normalization & format API Reference
PhysicalKeyCode
ts
type PhysicalKeyCode =
| `Key${LetterKey}`
| `Digit${NumberKey}`
| `Numpad${NumberKey}`
| `${"Alt" | "Control" | "Meta" | "Shift"}${"Left" | "Right"}`
| EditingKey
| NavigationKey
| FunctionKey
| typeof SHARED_NAMED_KEYS[number]
| "Backquote"
| "Backslash"
| "BracketLeft"
| "BracketRight"
| "Comma"
| "Equal"
| "IntlBackslash"
| "IntlRo"
| "IntlYen"
| "Minus"
| "Period"
| "Quote"
| "Semicolon"
| "Slash"
| `Lang${1 | 2 | 3 | 4 | 5}`
| `Numpad${"Add" | "Backspace" | "Clear" | "ClearEntry" | "Comma" | "Decimal" | "Divide" | "Enter" | "Equal" | "Hash" | "MemoryAdd" | "MemoryClear" | "MemoryRecall" | "MemoryStore" | "MemorySubtract" | "Multiply" | "ParenLeft" | "ParenRight" | "Star" | "Subtract"}`
| "LaunchApp1"
| "LaunchApp2"
| "MediaSelect"
| "Sleep"
| "Turbo"
| "Abort"
| "Resume"
| "Suspend";Defined in: key.types.ts:165
Supported physical KeyboardEvent.code names, independent of keyboard layout. Letter, digit, numpad, and sided modifier names use finite template unions. Unidentified is excluded because it cannot identify a physical key.
See#
https://www.w3.org/TR/uievents-code/