@tanstack/hotkeys
Classes
Interfaces
- CreateHotkeyHandlerOptions
- FormatDisplayOptions
- HeldModifierOptions
- HotkeyCallbackContext
- HotkeyConflictOptions
- HotkeyMeta
- HotkeyOptions
- HotkeyRecorderOptions
- HotkeyRecorderState
- HotkeyRecorderValidationContext
- HotkeyRegistration
- HotkeyRegistrationHandle
- HotkeyRegistrationView
- HotkeySequenceRecorderOptions
- HotkeySequenceRecorderState
- HotkeySequenceRecorderValidationContext
- KeyboardEventMatch
- KeyStateTrackerState
- NormalizedKeyboardEvent
- ParsedModifiers
- RawModifiers
- RecorderOptions
- RecorderRejection
- SequenceOptions
- SequenceRegistration
- SequenceRegistrationHandle
- SequenceRegistrationView
- ValidationResult
Type Aliases
- CanonicalModifier
- ConflictBehavior
- DisplayHotkey
- EditingKey
- FourModifierHotkey
- FunctionKey
- Hotkey
- HotkeyCallback
- HotkeyConflict
- HotkeySequence
- HotkeySequenceRecorderCommitKeys
- IndividualKey
- Key
- LetterKey
- LogicalKey
- Modifier
- MultiHotkeyHandler
- NamedKey
- NavigationKey
- NonPunctuationKey
- NumberKey
- ParsedHotkey
- PhysicalKey
- PhysicalKeyCode
- PunctuationKey
- RawHotkey
- RecorderKeyMode
- RegisterableHotkey
- SingleModifierHotkey
- Target
- ThreeModifierHotkey
- TwoModifierHotkey
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
- detectPlatform
- findHotkeyConflicts
- formatForDisplay
- formatHotkey
- formatHotkeySequence
formatWithLabels- getHotkeyManager
- getKeyStateTracker
- getSequenceManager
- hasNonModifierKey
- isModifierKey
- isSingleLetterKey
- matchesHeldModifiers
- matchesKeyboardEvent
- normalizeHotkey
- normalizeHotkeyFromEvent
- normalizeHotkeyFromParsed
- normalizeKeyName
- normalizeRegisterableHotkey
- parseHotkey
- parseKeyboardEvent
- parseRegisterableHotkey
- rawHotkeyToParsedHotkey
- resolveModifier
- toHotkeyRegistrationView
- validateHotkey