Skip to main content

Menu

Home
Frameworks
GitHub(opens in a new tab)

Getting Started

Overview
Installation
Devtools
Quick Start

Guides

Hotkeys
Sequences
Hotkey Recording
Hotkey Sequence Recording
Key State Tracking
Formatting & Display

API Reference

Core API
Lit Controllers & Decorators

HotkeyManager
getHotkeyManager
HotkeyOptions
HotkeyRegistration
HotkeyRegistrationHandle
HotkeyCallback
HotkeyCallbackContext
HotkeyMeta
HotkeyRegistrationView
toHotkeyRegistrationView
ConflictBehavior
HotkeyDefinition
hotkey
HotkeyController
HotkeyRegistrationsController

SequenceManager
getSequenceManager
SequenceOptions
createSequenceMatcher
HotkeySequence
SequenceRegistrationHandle
SequenceRegistrationView
HotkeySequenceDefinition
hotkeySequence
HotkeySequenceController

KeyStateTracker
getKeyStateTracker
KeyStateTrackerState
IndividualKey
matchesHeldModifiers
HeldModifierOptions
KeyHoldController
HeldKeysController
HeldKeyCodesController
HotkeyHintController

HotkeyRecorder
HotkeyRecorderOptions
HotkeyRecorderState
findHotkeyConflicts
HotkeyConflictOptions
HotkeyConflict
RecorderRejection
RecorderKeyMode
RecorderOptions
HotkeyRecorderValidationContext
HotkeyRecorderController

HotkeySequenceRecorder
HotkeySequenceRecorderOptions
HotkeySequenceRecorderState
HotkeySequenceRecorderCommitKeys
HotkeySequenceRecorderValidationContext
HotkeySequenceRecorderController

Examples

Kitchen Sink
hotkey
hotkey-sequence
hotkey-recorder
hotkey-sequence-recorder
held-keys
key-hold

@tanstack/lit-hotkeys

Classes

HeldKeyCodesController
HeldKeysController
HotkeyController
HotkeyHintController
HotkeyRecorderController
HotkeyRegistrationsController
HotkeySequenceController
HotkeySequenceRecorderController
KeyHoldController

Functions

hotkey
hotkeySequence

Adapted from tanstack.com/hotkeys/v0/docs/framework/lit/reference/index by Tanner Linsley, licensed under MIT. Changes were made: this page is re-rendered from the original's source.

PreviousCore API NextHotkeyManager

Translation © 2026 fanyi.dev · Original © 2026 Tanner Linsley (MIT)

Wide content