Libraries
Framework
Start
Router
Data & State
Query
DB
Store
AI
UI & UX
Table
Charts
Form
Hotkeys
Markdown
Highlight
Performance
Virtual
Pacer
Tooling
Devtools
Config
CLI
Intent
Browse all libraries
Blog
Blog & Release Notes
About
YouTube
The official TanStack channel.
Workshops
Live sessions from the maintainers.
Release Notes
The latest releases and changelog.
Community
Channels
Discord
Real-time community support.
GitHub
Source, issues, discussions, and releases.
People & Work
Maintainers
Meet the people maintaining the stack.
Showcase
Teams building with TanStack.
Tools
Tools
Builder
Alpha
Generate TanStack app starters.
Stats
NPM and ecosystem usage data.
Merch
View all
Support
Support
Support Overview
Find the right support path.
Partners
Companies supporting TanStack.
OSS Sponsors
Sponsors keeping TanStack open source.
Enterprise Support
Private consulting and expert support.
Contact
Get in touch with the TanStack team.
About
Ethos
How we approach open source.
Tenets
The values that shape TanStack libraries.
Design System
Logos, tokens, and UI components.
Search
Ask AI
Log In
Libraries
Blog
Community
Tools
Merch
Support
Search
Ask AI
Sign In
Back
Hotkeys Docs
Svelte
Latest
Search...
K
Home
Get Started
Guides
API
Examples
API Reference
Core API
Svelte APIs
Hotkeys API Reference
HotkeyManager
getHotkeyManager
HotkeyOptions
HotkeyRegistration
HotkeyRegistrationHandle
HotkeyCallback
HotkeyCallbackContext
HotkeyMeta
HotkeyRegistrationView
toHotkeyRegistrationView
ConflictBehavior
createHotkey
createHotkeys
createHotkeyAttachment
createHotkeysAttachment
CreateHotkeyOptions
CreateHotkeyDefinition
HotkeysProvider
HotkeysProviderOptions
HotkeysProviderProps
DEFAULT_OPTIONS
getDefaultHotkeysOptions
getHotkeysContext
setHotkeysContext
getHotkeyRegistrations
SvelteHotkeyRegistrations
Hotkey Sequence API Reference
SequenceManager
getSequenceManager
SequenceOptions
createSequenceMatcher
HotkeySequence
SequenceRegistrationHandle
SequenceRegistrationView
createHotkeySequence
createHotkeySequenceAttachment
CreateHotkeySequenceOptions
createHotkeySequences
createHotkeySequencesAttachment
CreateHotkeySequenceDefinition
Key hold & held keys API Reference
KeyStateTracker
getKeyStateTracker
KeyStateTrackerState
IndividualKey
getIsKeyHeld
SvelteHeldKeyState
getHeldKeys
SvelteHeldKeys
getHeldKeyCodesMap
SvelteHeldKeyCodesMap
Hotkey Recorder API Reference
HotkeyRecorder
HotkeyRecorderOptions
HotkeyRecorderState
createHotkeyRecorder
SvelteHotkeyRecorder
Hotkey Sequence Recorder API Reference
HotkeySequenceRecorder
HotkeySequenceRecorderOptions
HotkeySequenceRecorderState
HotkeySequenceRecorderCommitKeys
createHotkeySequenceRecorder
SvelteHotkeySequenceRecorder
Normalization & format API Reference
normalizeHotkey
normalizeHotkeyFromParsed
normalizeHotkeyFromEvent
normalizeRegisterableHotkey
formatForDisplay
formatHotkey
formatWithLabels
FormatDisplayOptions
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
Hotkeys
Menu
Menu
Home
Get Started
Guides
API
Examples
Svelte
Latest
API Reference
Core API
Svelte APIs
Hotkeys API Reference
HotkeyManager
getHotkeyManager
HotkeyOptions
HotkeyRegistration
HotkeyRegistrationHandle
HotkeyCallback
HotkeyCallbackContext
HotkeyMeta
HotkeyRegistrationView
toHotkeyRegistrationView
ConflictBehavior
createHotkey
createHotkeys
createHotkeyAttachment
createHotkeysAttachment
CreateHotkeyOptions
CreateHotkeyDefinition
HotkeysProvider
HotkeysProviderOptions
HotkeysProviderProps
DEFAULT_OPTIONS
getDefaultHotkeysOptions
getHotkeysContext
setHotkeysContext
getHotkeyRegistrations
SvelteHotkeyRegistrations
Hotkey Sequence API Reference
SequenceManager
getSequenceManager
SequenceOptions
createSequenceMatcher
HotkeySequence
SequenceRegistrationHandle
SequenceRegistrationView
createHotkeySequence
createHotkeySequenceAttachment
CreateHotkeySequenceOptions
createHotkeySequences
createHotkeySequencesAttachment
CreateHotkeySequenceDefinition
Key hold & held keys API Reference
KeyStateTracker
getKeyStateTracker
KeyStateTrackerState
IndividualKey
getIsKeyHeld
SvelteHeldKeyState
getHeldKeys
SvelteHeldKeys
getHeldKeyCodesMap
SvelteHeldKeyCodesMap
Hotkey Recorder API Reference
HotkeyRecorder
HotkeyRecorderOptions
HotkeyRecorderState
createHotkeyRecorder
SvelteHotkeyRecorder
Hotkey Sequence Recorder API Reference
HotkeySequenceRecorder
HotkeySequenceRecorderOptions
HotkeySequenceRecorderState
HotkeySequenceRecorderCommitKeys
createHotkeySequenceRecorder
SvelteHotkeySequenceRecorder
Normalization & format API Reference
normalizeHotkey
normalizeHotkeyFromParsed
normalizeHotkeyFromEvent
normalizeRegisterableHotkey
formatForDisplay
formatHotkey
formatWithLabels
FormatDisplayOptions
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/framework/svelte/reference/index.md
API Reference
On this page
@tanstack/svelte-hotkeys
Copy page
@tanstack/svelte-hotkeys
#
Interfaces
#
CreateHotkeyDefinition
CreateHotkeyOptions
CreateHotkeySequenceDefinition
CreateHotkeySequenceOptions
HotkeysProviderOptions
HotkeysProviderProps
SvelteHeldKeyCodesMap
SvelteHeldKeys
SvelteHeldKeyState
SvelteHotkeyRecorder
SvelteHotkeyRegistrations
SvelteHotkeySequenceRecorder
Type Aliases
#
HotkeysProvider
Variables
#
DEFAULT_OPTIONS
HotkeysProvider
Functions
#
createHotkey
createHotkeyAttachment
createHotkeyRecorder
createHotkeys
createHotkeysAttachment
createHotkeySequence
createHotkeySequenceAttachment
createHotkeySequenceRecorder
createHotkeySequences
createHotkeySequencesAttachment
getDefaultHotkeysOptions
getHeldKeyCodesMap
getHeldKeys
getHotkeyRegistrations
getHotkeysContext
getIsKeyHeld
setHotkeysContext
Edit on GitHub
Previous
Core API
Next
HotkeyManager
On this page
@tanstack/svelte-hotkeys
Interfaces
Type Aliases
Variables
Functions
Partners
Become a Partner
Gold
Silver
Bronze
Latest Posts