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/index.md
API Reference
@tanstack/hotkeys
Classes#
Interfaces#
- AppHotkey
- AppHotkeyInput
- AppHotkeyListItem
- AppHotkeysState
- AppHotkeysStoreOptions
- CreateHotkeyHandlerOptions
- FormatDisplayOptions
- HeldModifierOptions
- HotkeyCallbackContext
- HotkeyChordOptions
- HotkeyChordRecorderOptions
- HotkeyChordRegistration
- HotkeyChordRegistrationView
- HotkeyConflict
- HotkeyConflictOptions
- HotkeyMeta
- HotkeyOptions
- HotkeyRecorderState
- HotkeyRecorderValidationContext
- HotkeyRegistrationHandle
- HotkeySequenceOptions
- HotkeySequenceRecorderOptions
- HotkeySequenceRegistration
- HotkeySequenceRegistrationView
- KeyboardEventMatch
- KeyStateTrackerState
- NormalizedKeyboardEvent
- ParsedModifiers
- RawModifiers
- RecorderOptions
- RecorderRejection
- Register
- ValidationResult
Type Aliases#
- AppHotkeyChordOptions
- AppHotkeyDefaultKind
- AppHotkeyId
- AppHotkeyOptions
- AppHotkeys
- AppHotkeySequenceOptions
- AppHotkeyStatus
- CanonicalModifier
- ConflictBehavior
- CustomHotkeys
- DefinedAppHotkeys
- DisplayHotkey
- DisplayHotkeyChord
- EditingKey
- FourModifierHotkey
- FunctionKey
- Hotkey
- HotkeyCallback
- HotkeyChord
- HotkeyOptionsFor
- HotkeyRecorderCommitKeys
- HotkeyRecorderOptions
- HotkeyRegistration
- HotkeyRegistrationView
- HotkeySequence
- IndividualKey
- Key
- LetterKey
- LogicalKey
- Modifier
- MultiHotkeyHandler
- NamedKey
- NavigationKey
- NonPunctuationKey
- NumberKey
- ParsedHotkey
- PhysicalKey
- PhysicalKeyCode
- PunctuationKey
- RawHotkey
- RecorderKeyMode
- RegisterableHotkey
- RegisterableHotkeyChord
- RegisteredAppHotkeys
- SingleModifierHotkey
- Target
- ThreeModifierHotkey
- TwoModifierHotkey
- ValidatableHotkey
Variables#
- ALL_KEYS
- DEFAULT_SEQUENCE_TIMEOUT
- EDITING_KEYS
- FUNCTION_KEYS
- KEY_DISPLAY_SYMBOLS
- LETTER_KEYS
- LINUX_MODIFIER_LABELS
- MAC_MODIFIER_LABELS
- MAC_MODIFIER_SYMBOLS
- MODIFIER_ALIASES
- MODIFIER_KEYS
- MODIFIER_ORDER
- NAVIGATION_KEYS
- NUMBER_KEYS
- PUNCTUATION_CODE_MAP
- PUNCTUATION_KEY_DISPLAY_LABELS
- PUNCTUATION_KEYS
- WINDOWS_MODIFIER_LABELS
Functions#
- areHotkeysEqual
- assertValidHotkey
- checkHotkey
- createHotkeyHandler
- createMultiHotkeyHandler
- createSequenceMatcher
- defineAppHotkeys
- detectPlatform
- findHotkeyConflicts
- formatForDisplay
- formatHotkey
- getAppHotkeyRegistrationOptions
- getHotkeyManager
- getKeyStateTracker
- hasNonModifierKey
- isAppHotkey
- isCustomHotkey
- isHotkeySequence
- isModifierKey
- isSingleLetterKey
- matchesHeldModifiers
- matchesKeyboardEvent
- normalizeHotkey
- normalizeHotkeyFromEvent
- normalizeHotkeyFromParsed
- normalizeKeyName
- normalizeRegisterableHotkey
- parseHotkey
- parseKeyboardEvent
- parseRegisterableHotkey
- provideAppHotkeys
- publishAppHotkeysStore
- rawHotkeyToParsedHotkey
- resolveAppHotkey
- resolveModifier
- simplifyHotkey
- toHotkeyRegistrationView
- validateHotkey