Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/add-lit-adapter.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
'@tanstack/lit-hotkeys': minor
'@tanstack/hotkeys': patch
---

Add `@tanstack/lit-hotkeys` package with Lit reactive controllers and decorators for hotkeys, hotkey sequences, key hold, held keys, hotkey recording, and sequence recording. Also fix input element detection inside shadow DOMs in the core hotkeys package.
1 change: 1 addition & 0 deletions .npmrc
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
provenance=true
use-node-version=24.14.1
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ Type-safe keyboard shortcuts for the web. Template-string bindings, parsed objec
> - [**Solid Hotkeys**](https://tanstack.com/hotkeys/latest/docs/framework/solid/reference)
> - [**Angular Hotkeys**](https://tanstack.com/hotkeys/latest/docs/framework/angular/reference)
> - [**Vue Hotkeys**](https://tanstack.com/hotkeys/latest/docs/framework/vue/reference)
> - [**Lit Hotkeys**](https://tanstack.com/hotkeys/latest/docs/framework/lit/reference)
> - [**Svelte Hotkeys**](https://tanstack.com/hotkeys/latest/docs/framework/svelte/reference)

## Get Involved
Expand Down
137 changes: 137 additions & 0 deletions docs/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,15 @@
}
]
},
{
"label": "lit",
"children": [
{
"label": "Quick Start",
"to": "framework/lit/quick-start"
}
]
},
{
"label": "svelte",
"children": [
Expand Down Expand Up @@ -228,6 +237,35 @@
}
]
},
{
"label": "lit",
"children": [
{
"label": "Hotkeys",
"to": "framework/lit/guides/hotkeys"
},
{
"label": "Sequences",
"to": "framework/lit/guides/sequences"
},
{
"label": "Hotkey Recording",
"to": "framework/lit/guides/hotkey-recording"
},
{
"label": "Hotkey Sequence Recording",
"to": "framework/lit/guides/sequence-recording"
},
{
"label": "Key State Tracking",
"to": "framework/lit/guides/key-state-tracking"
},
{
"label": "Formatting & Display",
"to": "framework/lit/guides/formatting-display"
}
]
},
Comment thread
fredericbahr marked this conversation as resolved.
{
"label": "svelte",
"children": [
Expand Down Expand Up @@ -313,6 +351,15 @@
}
]
},
{
"label": "lit",
"children": [
{
"label": "Lit Controllers & Decorators",
"to": "framework/lit/reference/index"
}
]
},
{
"label": "svelte",
"children": [
Expand Down Expand Up @@ -548,6 +595,19 @@
}
]
},
{
"label": "lit",
"children": [
{
"label": "hotkey",
"to": "framework/lit/reference/functions/hotkey"
},
{
"label": "HotkeyController",
"to": "framework/lit/reference/classes/HotkeyController"
}
]
},
{
"label": "svelte",
"children": [
Expand Down Expand Up @@ -747,6 +807,19 @@
}
]
},
{
"label": "lit",
"children": [
{
"label": "hotkeySequence",
"to": "framework/lit/reference/functions/hotkeySequence"
},
{
"label": "HotkeySequenceController",
"to": "framework/lit/reference/classes/HotkeySequenceController"
}
]
},
{
"label": "svelte",
"children": [
Expand Down Expand Up @@ -886,6 +959,23 @@
}
]
},
{
"label": "lit",
"children": [
{
"label": "KeyHoldController",
"to": "framework/lit/reference/classes/KeyHoldController"
},
{
"label": "HeldKeysController",
"to": "framework/lit/reference/classes/HeldKeysController"
},
{
"label": "HeldKeyCodesController",
"to": "framework/lit/reference/classes/HeldKeyCodesController"
}
]
},
{
"label": "svelte",
"children": [
Expand Down Expand Up @@ -1001,6 +1091,15 @@
}
]
},
{
"label": "lit",
"children": [
{
"label": "HotkeyRecorderController",
"to": "framework/lit/reference/classes/HotkeyRecorderController"
}
]
},
{
"label": "svelte",
"children": [
Expand Down Expand Up @@ -1104,6 +1203,15 @@
}
]
},
{
"label": "lit",
"children": [
{
"label": "HotkeySequenceRecorderController",
"to": "framework/lit/reference/classes/HotkeySequenceRecorderController"
}
]
},
{
"label": "svelte",
"children": [
Expand Down Expand Up @@ -1388,6 +1496,35 @@
}
]
},
{
"label": "lit",
"children": [
{
"label": "hotkey",
"to": "framework/lit/examples/hotkey"
},
{
"label": "hotkey-sequence",
"to": "framework/lit/examples/hotkey-sequence"
},
{
"label": "hotkey-recorder",
"to": "framework/lit/examples/hotkey-recorder"
},
{
"label": "hotkey-sequence-recorder",
"to": "framework/lit/examples/hotkey-sequence-recorder"
},
{
"label": "held-keys",
"to": "framework/lit/examples/held-keys"
},
{
"label": "key-hold",
"to": "framework/lit/examples/key-hold"
}
]
},
{
"label": "svelte",
"children": [
Expand Down
2 changes: 1 addition & 1 deletion docs/devtools.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ npm install @tanstack/solid-devtools @tanstack/solid-hotkeys-devtools
npm install @tanstack/vue-hotkeys-devtools
```

Angular does not currently ship a dedicated hotkeys devtools adapter.
Angular and Lit do not currently ship a dedicated hotkeys devtools adapter.

## Setup

Expand Down
Loading
Loading