@tanstack/hotkeys#

Classes#

• HotkeyManager

• HotkeyRecorder

• HotkeySequenceRecorder

• KeyStateTracker

• SequenceManager

Interfaces#

• CreateHotkeyHandlerOptions

• FormatDisplayOptions

• HotkeyCallbackContext

• HotkeyMeta

• HotkeyOptions

• HotkeyRecorderOptions

• HotkeyRecorderState

• HotkeyRegistration

• HotkeyRegistrationHandle

• HotkeyRegistrationView

• HotkeySequenceRecorderOptions

• HotkeySequenceRecorderState

• KeyStateTrackerState

• ParsedHotkey

• RawHotkey

• SequenceOptions

• SequenceRegistrationHandle

• SequenceRegistrationView

• ValidationResult

Type Aliases#

• CanonicalModifier

• ConflictBehavior

• EditingKey

• FunctionKey

• Hotkey

• HotkeyCallback

• HotkeySequence

• HotkeySequenceRecorderCommitKeys

• IndividualKey

• Key

• LetterKey

• Modifier

• NavigationKey

• NumberKey

• PunctuationKey

• RegisterableHotkey

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#

• assertValidHotkey
• checkHotkey
• createHotkeyHandler
• createMultiHotkeyHandler
• createSequenceMatcher
• detectPlatform
• formatForDisplay
• formatHotkey
• formatHotkeySequence
• formatWithLabels
• getHotkeyManager
• getKeyStateTracker
• getSequenceManager
• hasNonModifierKey
• isModifierKey
• isSingleLetterKey
• matchesKeyboardEvent
• normalizeHotkey
• normalizeHotkeyFromEvent
• normalizeHotkeyFromParsed
• normalizeKeyName
• normalizeRegisterableHotkey
• parseHotkey
• parseKeyboardEvent
• rawHotkeyToParsedHotkey
• resolveModifier
• toHotkeyRegistrationView
• validateHotkey