@tanstack/hotkeys 0.7.1 → 0.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +15 -1
- package/dist/{manager.utils.js → _event-target.cjs} +5 -41
- package/dist/_event-target.cjs.map +1 -0
- package/dist/{manager.utils.cjs → _event-target.js} +3 -47
- package/dist/_event-target.js.map +1 -0
- package/dist/_keyboard-event.cjs +83 -0
- package/dist/_keyboard-event.cjs.map +1 -0
- package/dist/_keyboard-event.js +76 -0
- package/dist/_keyboard-event.js.map +1 -0
- package/dist/_match.cjs +49 -0
- package/dist/_match.cjs.map +1 -0
- package/dist/_match.js +49 -0
- package/dist/_match.js.map +1 -0
- package/dist/_named-keys.cjs +68 -0
- package/dist/_named-keys.cjs.map +1 -0
- package/dist/_named-keys.d.cts +8 -0
- package/dist/_named-keys.d.ts +8 -0
- package/dist/_named-keys.js +66 -0
- package/dist/_named-keys.js.map +1 -0
- package/dist/_recorder-chord.cjs +44 -0
- package/dist/_recorder-chord.cjs.map +1 -0
- package/dist/_recorder-chord.js +43 -0
- package/dist/_recorder-chord.js.map +1 -0
- package/dist/_recording-guard.cjs +59 -0
- package/dist/_recording-guard.cjs.map +1 -0
- package/dist/_recording-guard.js +56 -0
- package/dist/_recording-guard.js.map +1 -0
- package/dist/_registration.cjs +54 -0
- package/dist/_registration.cjs.map +1 -0
- package/dist/_registration.js +50 -0
- package/dist/_registration.js.map +1 -0
- package/dist/conflicts.cjs +55 -0
- package/dist/conflicts.cjs.map +1 -0
- package/dist/conflicts.d.cts +39 -0
- package/dist/conflicts.d.ts +39 -0
- package/dist/conflicts.js +55 -0
- package/dist/conflicts.js.map +1 -0
- package/dist/constants.cjs +46 -171
- package/dist/constants.cjs.map +1 -1
- package/dist/constants.d.cts +4 -129
- package/dist/constants.d.ts +4 -129
- package/dist/constants.js +48 -164
- package/dist/constants.js.map +1 -1
- package/dist/display-labels.cjs +119 -0
- package/dist/display-labels.cjs.map +1 -0
- package/dist/display-labels.d.cts +93 -0
- package/dist/display-labels.d.ts +93 -0
- package/dist/display-labels.js +113 -0
- package/dist/display-labels.js.map +1 -0
- package/dist/format.cjs +30 -36
- package/dist/format.cjs.map +1 -1
- package/dist/format.d.cts +46 -7
- package/dist/format.d.ts +46 -7
- package/dist/format.js +31 -37
- package/dist/format.js.map +1 -1
- package/dist/hint.cjs +24 -0
- package/dist/hint.cjs.map +1 -0
- package/dist/hint.d.cts +23 -0
- package/dist/hint.d.ts +23 -0
- package/dist/hint.js +24 -0
- package/dist/hint.js.map +1 -0
- package/dist/hotkey-manager.cjs +53 -22
- package/dist/hotkey-manager.cjs.map +1 -1
- package/dist/hotkey-manager.d.cts +6 -2
- package/dist/hotkey-manager.d.ts +6 -2
- package/dist/hotkey-manager.js +49 -18
- package/dist/hotkey-manager.js.map +1 -1
- package/dist/hotkey-recorder.cjs +67 -11
- package/dist/hotkey-recorder.cjs.map +1 -1
- package/dist/hotkey-recorder.d.cts +6 -3
- package/dist/hotkey-recorder.d.ts +6 -3
- package/dist/hotkey-recorder.js +66 -10
- package/dist/hotkey-recorder.js.map +1 -1
- package/dist/hotkey-sequence-recorder.cjs +85 -22
- package/dist/hotkey-sequence-recorder.cjs.map +1 -1
- package/dist/hotkey-sequence-recorder.d.cts +9 -2
- package/dist/hotkey-sequence-recorder.d.ts +9 -2
- package/dist/hotkey-sequence-recorder.js +84 -21
- package/dist/hotkey-sequence-recorder.js.map +1 -1
- package/dist/{hotkey.d.ts → hotkey.types.d.cts} +55 -120
- package/dist/{hotkey.d.cts → hotkey.types.d.ts} +55 -120
- package/dist/index.cjs +18 -10
- package/dist/index.d.cts +14 -9
- package/dist/index.d.ts +14 -9
- package/dist/index.js +10 -6
- package/dist/key-state-tracker.cjs +24 -24
- package/dist/key-state-tracker.cjs.map +1 -1
- package/dist/key-state-tracker.js +24 -24
- package/dist/key-state-tracker.js.map +1 -1
- package/dist/key.types.d.cts +82 -0
- package/dist/key.types.d.ts +82 -0
- package/dist/match.cjs +21 -30
- package/dist/match.cjs.map +1 -1
- package/dist/match.d.cts +19 -3
- package/dist/match.d.ts +19 -3
- package/dist/match.js +19 -29
- package/dist/match.js.map +1 -1
- package/dist/parse.cjs +43 -26
- package/dist/parse.cjs.map +1 -1
- package/dist/parse.d.cts +10 -4
- package/dist/parse.d.ts +10 -4
- package/dist/parse.js +35 -19
- package/dist/parse.js.map +1 -1
- package/dist/platform.cjs +55 -0
- package/dist/platform.cjs.map +1 -0
- package/dist/platform.d.cts +44 -0
- package/dist/platform.d.ts +44 -0
- package/dist/platform.js +53 -0
- package/dist/platform.js.map +1 -0
- package/dist/recorder-options.d.cts +34 -0
- package/dist/recorder-options.d.ts +34 -0
- package/dist/sequence-manager.cjs +54 -28
- package/dist/sequence-manager.cjs.map +1 -1
- package/dist/sequence-manager.d.cts +18 -3
- package/dist/sequence-manager.d.ts +18 -3
- package/dist/sequence-manager.js +49 -23
- package/dist/sequence-manager.js.map +1 -1
- package/dist/validate.cjs +6 -10
- package/dist/validate.cjs.map +1 -1
- package/dist/validate.d.cts +13 -2
- package/dist/validate.d.ts +13 -2
- package/dist/validate.js +7 -11
- package/dist/validate.js.map +1 -1
- package/package.json +2 -2
- package/src/{manager.utils.ts → _event-target.ts} +0 -74
- package/src/_keyboard-event.ts +101 -0
- package/src/_match.ts +96 -0
- package/src/_named-keys.ts +62 -0
- package/src/_recorder-chord.ts +76 -0
- package/src/_recording-guard.ts +63 -0
- package/src/_registration.ts +79 -0
- package/src/conflicts.ts +125 -0
- package/src/constants.ts +48 -196
- package/src/display-labels.ts +123 -0
- package/src/format.ts +111 -52
- package/src/hint.ts +42 -0
- package/src/hotkey-manager.ts +95 -40
- package/src/hotkey-recorder.ts +92 -16
- package/src/hotkey-sequence-recorder.ts +110 -28
- package/src/{hotkey.ts → hotkey.types.ts} +57 -224
- package/src/index.ts +11 -5
- package/src/key-state-tracker.ts +36 -24
- package/src/key.types.ts +268 -0
- package/src/match.ts +41 -90
- package/src/parse.ts +67 -26
- package/src/platform.ts +66 -0
- package/src/recorder-options.ts +34 -0
- package/src/sequence-manager.ts +77 -42
- package/src/validate.ts +29 -21
- package/dist/manager.utils.cjs.map +0 -1
- package/dist/manager.utils.d.cts +0 -13
- package/dist/manager.utils.d.ts +0 -13
- package/dist/manager.utils.js.map +0 -1
- package/dist/recorder-chord.cjs +0 -18
- package/dist/recorder-chord.cjs.map +0 -1
- package/dist/recorder-chord.js +0 -18
- package/dist/recorder-chord.js.map +0 -1
- package/src/recorder-chord.ts +0 -25
|
@@ -1,66 +1,9 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
* - Control/Ctrl: The Control key
|
|
5
|
-
* - Shift: The Shift key
|
|
6
|
-
* - Alt/Option: The Alt key (Option on macOS)
|
|
7
|
-
* - Command/Cmd: The Command key (macOS only)
|
|
8
|
-
* - CommandOrControl/Mod: Command on macOS, Control on other platforms
|
|
9
|
-
*/
|
|
10
|
-
type Modifier = 'Control' | 'Ctrl' | 'Shift' | 'Alt' | 'Option' | 'Command' | 'Cmd' | 'CommandOrControl' | 'Mod';
|
|
11
|
-
/**
|
|
12
|
-
* Canonical modifier names that map to KeyboardEvent properties.
|
|
13
|
-
*/
|
|
14
|
-
type CanonicalModifier = 'Control' | 'Shift' | 'Alt' | 'Meta';
|
|
15
|
-
/**
|
|
16
|
-
* Letter keys A-Z (case-insensitive in matching).
|
|
17
|
-
*/
|
|
18
|
-
type LetterKey = 'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G' | 'H' | 'I' | 'J' | 'K' | 'L' | 'M' | 'N' | 'O' | 'P' | 'Q' | 'R' | 'S' | 'T' | 'U' | 'V' | 'W' | 'X' | 'Y' | 'Z';
|
|
19
|
-
/**
|
|
20
|
-
* Number keys 0-9.
|
|
21
|
-
*/
|
|
22
|
-
type NumberKey = '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9';
|
|
23
|
-
/**
|
|
24
|
-
* Function keys F1-F12.
|
|
25
|
-
*/
|
|
26
|
-
type FunctionKey = 'F1' | 'F2' | 'F3' | 'F4' | 'F5' | 'F6' | 'F7' | 'F8' | 'F9' | 'F10' | 'F11' | 'F12';
|
|
27
|
-
/**
|
|
28
|
-
* Navigation keys for cursor movement.
|
|
29
|
-
*/
|
|
30
|
-
type NavigationKey = 'ArrowUp' | 'ArrowDown' | 'ArrowLeft' | 'ArrowRight' | 'Home' | 'End' | 'PageUp' | 'PageDown';
|
|
31
|
-
/**
|
|
32
|
-
* Editing and special keys.
|
|
33
|
-
*/
|
|
34
|
-
type EditingKey = 'Enter' | 'Escape' | 'Space' | 'Tab' | 'Backspace' | 'Delete';
|
|
35
|
-
/**
|
|
36
|
-
* Punctuation keys commonly used in keyboard shortcuts.
|
|
37
|
-
* These are the literal characters as they appear in KeyboardEvent.key
|
|
38
|
-
* (layout-dependent, typically US keyboard layout).
|
|
39
|
-
*/
|
|
40
|
-
type PunctuationKey = '/' | '[' | ']' | '\\' | '=' | '-' | ',' | '.' | ';' | '`';
|
|
41
|
-
/**
|
|
42
|
-
* Keys that don't change their value when Shift is pressed.
|
|
43
|
-
* These keys produce the same `KeyboardEvent.key` value whether Shift is held or not.
|
|
44
|
-
*
|
|
45
|
-
* Excludes NumberKey (Shift+1 produces '!' on US layout) and PunctuationKey
|
|
46
|
-
* (Shift+',' produces '<' on US layout).
|
|
47
|
-
*
|
|
48
|
-
* Used in hotkey type definitions to prevent layout-dependent issues when Shift
|
|
49
|
-
* is part of the modifier combination.
|
|
50
|
-
*/
|
|
51
|
-
type NonPunctuationKey = LetterKey | NumberKey | EditingKey | NavigationKey | FunctionKey;
|
|
52
|
-
/**
|
|
53
|
-
* All supported non-modifier keys.
|
|
54
|
-
*/
|
|
55
|
-
type Key = NonPunctuationKey | PunctuationKey;
|
|
56
|
-
/**
|
|
57
|
-
* Includes both modifier keys and regular keys.
|
|
58
|
-
*/
|
|
59
|
-
type IndividualKey = CanonicalModifier | Key;
|
|
1
|
+
import { CanonicalModifier, Key, LogicalKey } from "./key.types.js";
|
|
2
|
+
|
|
3
|
+
//#region src/hotkey.types.d.ts
|
|
60
4
|
/**
|
|
61
5
|
* Single modifier + key combinations.
|
|
62
6
|
* Uses canonical modifiers (4) + Mod (1) = 5 modifiers.
|
|
63
|
-
* Shift combinations exclude PunctuationKey to avoid layout-dependent issues.
|
|
64
7
|
*
|
|
65
8
|
* The `Mod` modifier is platform-adaptive:
|
|
66
9
|
* - **macOS**: Resolves to `Meta` (Command key ⌘)
|
|
@@ -69,10 +12,9 @@ type IndividualKey = CanonicalModifier | Key;
|
|
|
69
12
|
* This enables cross-platform hotkey definitions that automatically adapt to the platform.
|
|
70
13
|
* For example, `Mod+S` becomes `Command+S` on Mac and `Ctrl+S` on Windows/Linux.
|
|
71
14
|
*/
|
|
72
|
-
type SingleModifierHotkey = `Control+${Key}` | `Alt+${Key}` | `Shift+${
|
|
15
|
+
type SingleModifierHotkey = `Control+${Key}` | `Alt+${Key}` | `Shift+${Key}` | `Meta+${Key}` | `Mod+${Key}`;
|
|
73
16
|
/**
|
|
74
17
|
* Two modifier + key combinations.
|
|
75
|
-
* Shift combinations exclude Numbers and PunctuationKeys to avoid layout-dependent issues.
|
|
76
18
|
*
|
|
77
19
|
* **Platform-adaptive `Mod` combinations:**
|
|
78
20
|
* - `Mod+Alt` and `Mod+Shift` are included (safe on all platforms)
|
|
@@ -80,10 +22,9 @@ type SingleModifierHotkey = `Control+${Key}` | `Alt+${Key}` | `Shift+${NonPunctu
|
|
|
80
22
|
* - `Mod+Control` duplicates `Control` on Windows/Linux (Mod = Control)
|
|
81
23
|
* - `Mod+Meta` duplicates `Meta` on macOS (Mod = Meta)
|
|
82
24
|
*/
|
|
83
|
-
type TwoModifierHotkey = `Control+Alt+${Key}` | `Control+Shift+${
|
|
25
|
+
type TwoModifierHotkey = `Control+Alt+${Key}` | `Control+Shift+${Key}` | `Control+Meta+${Key}` | `Alt+Shift+${Key}` | `Alt+Meta+${Key}` | `Shift+Meta+${Key}` | `Mod+Alt+${Key}` | `Mod+Shift+${Key}`;
|
|
84
26
|
/**
|
|
85
27
|
* Three modifier + key combinations.
|
|
86
|
-
* Shift combinations exclude Numbers and PunctuationKeys to avoid layout-dependent issues.
|
|
87
28
|
*
|
|
88
29
|
* **Platform-adaptive `Mod` combinations:**
|
|
89
30
|
* - `Mod+Alt+Shift` is included (safe on all platforms)
|
|
@@ -91,10 +32,9 @@ type TwoModifierHotkey = `Control+Alt+${Key}` | `Control+Shift+${NonPunctuationK
|
|
|
91
32
|
* - `Mod+Control+Shift` duplicates `Control` on Windows/Linux (Mod = Control)
|
|
92
33
|
* - `Mod+Shift+Meta` duplicates `Meta` on macOS (Mod = Meta)
|
|
93
34
|
*/
|
|
94
|
-
type ThreeModifierHotkey = `Control+Alt+Shift+${
|
|
35
|
+
type ThreeModifierHotkey = `Control+Alt+Shift+${Key}` | `Control+Alt+Meta+${Key}` | `Control+Shift+Meta+${Key}` | `Alt+Shift+Meta+${Key}` | `Mod+Alt+Shift+${Key}`;
|
|
95
36
|
/**
|
|
96
37
|
* Four modifier + key combinations.
|
|
97
|
-
* Shift combinations exclude Numbers and PunctuationKeys to avoid layout-dependent issues.
|
|
98
38
|
*
|
|
99
39
|
* Only the canonical `Control+Alt+Shift+Meta` combination is included.
|
|
100
40
|
*
|
|
@@ -105,7 +45,7 @@ type ThreeModifierHotkey = `Control+Alt+Shift+${NonPunctuationKey}` | `Control+A
|
|
|
105
45
|
* - `Mod+Control+Alt+Shift` → duplicates `Control` on Windows/Linux
|
|
106
46
|
* - `Mod+Alt+Shift+Meta` → duplicates `Meta` on macOS
|
|
107
47
|
*/
|
|
108
|
-
type FourModifierHotkey = `Control+Alt+Shift+Meta+${
|
|
48
|
+
type FourModifierHotkey = `Control+Alt+Shift+Meta+${Key}`;
|
|
109
49
|
/**
|
|
110
50
|
* A type-safe hotkey string.
|
|
111
51
|
*
|
|
@@ -159,38 +99,35 @@ type FourModifierHotkey = `Control+Alt+Shift+Meta+${NonPunctuationKey}`;
|
|
|
159
99
|
* ```
|
|
160
100
|
*/
|
|
161
101
|
type Hotkey = Key | SingleModifierHotkey | TwoModifierHotkey | ThreeModifierHotkey | FourModifierHotkey;
|
|
162
|
-
/**
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
* This interface provides a flexible fallback when the `Hotkey` type doesn't
|
|
166
|
-
* fit your use case. You can pass a `ParsedHotkey` directly to hotkey functions
|
|
167
|
-
* instead of a hotkey string, allowing for more dynamic or complex scenarios
|
|
168
|
-
* that aren't covered by the type-safe `Hotkey` union.
|
|
169
|
-
*
|
|
170
|
-
* @example
|
|
171
|
-
* ```ts
|
|
172
|
-
* // Type-safe hotkey string
|
|
173
|
-
* useHotkey('Mod+S', handler)
|
|
174
|
-
*
|
|
175
|
-
* // Fallback: parsed hotkey for dynamic scenarios
|
|
176
|
-
* const parsed = parseHotkey(userInput)
|
|
177
|
-
* useHotkey(parsed, handler) // Works even if userInput isn't in Hotkey type
|
|
178
|
-
* ```
|
|
179
|
-
*/
|
|
180
|
-
interface ParsedHotkey {
|
|
181
|
-
/** The non-modifier key (e.g., 'S', 'Escape', 'F1', '/', '['). Can be any string for flexibility. */
|
|
182
|
-
key: Key | (string & {});
|
|
183
|
-
/** Whether the Control key is required */
|
|
102
|
+
/** Resolved modifier flags shared by both parsed binding variants. */
|
|
103
|
+
interface ParsedModifiers {
|
|
104
|
+
/** Whether Control is required. */
|
|
184
105
|
ctrl: boolean;
|
|
185
|
-
/** Whether
|
|
106
|
+
/** Whether Shift is required. */
|
|
186
107
|
shift: boolean;
|
|
187
|
-
/** Whether
|
|
108
|
+
/** Whether Alt is required. */
|
|
188
109
|
alt: boolean;
|
|
189
|
-
/** Whether
|
|
110
|
+
/** Whether Meta (Command) is required. */
|
|
190
111
|
meta: boolean;
|
|
191
|
-
/**
|
|
112
|
+
/** Required modifiers in canonical order. */
|
|
192
113
|
modifiers: Array<CanonicalModifier>;
|
|
193
114
|
}
|
|
115
|
+
/**
|
|
116
|
+
* A parsed binding matches either a logical key or a physical code, never both.
|
|
117
|
+
* Check `code !== undefined` to narrow to a physical binding. Its logical
|
|
118
|
+
* character is unknown without a keyboard event and is not stored in `key`.
|
|
119
|
+
*
|
|
120
|
+
* @example
|
|
121
|
+
* parseHotkey('Alt+S') // { key: 'S', alt: true, ... }
|
|
122
|
+
* parseHotkey('Alt+[KeyS]') // { code: 'KeyS', alt: true, ... } — no key property
|
|
123
|
+
*/
|
|
124
|
+
type ParsedHotkey = ParsedModifiers & ({
|
|
125
|
+
key: LogicalKey | (string & {});
|
|
126
|
+
code?: never;
|
|
127
|
+
} | {
|
|
128
|
+
code: string;
|
|
129
|
+
key?: never;
|
|
130
|
+
});
|
|
194
131
|
/**
|
|
195
132
|
* A raw hotkey object for programmatic registration.
|
|
196
133
|
*
|
|
@@ -209,11 +146,13 @@ interface ParsedHotkey {
|
|
|
209
146
|
* useHotkey({ key: 'Escape' }, handler) // Escape (no modifiers)
|
|
210
147
|
* useHotkey({ key: 'A', shift: true, meta: true }, handler) // Shift+Meta+A
|
|
211
148
|
* useHotkey({ key: 'S', mod: true, shift: true }, handler) // Mod+Shift+S
|
|
149
|
+
* useHotkey({ code: 'KeyW', mod: true }, handler) // Physical Mod+KeyW
|
|
150
|
+
* useHotkey({ code: 'NumpadAdd', mod: true }, handler) // Physical numpad plus
|
|
212
151
|
* ```
|
|
213
152
|
*/
|
|
214
|
-
|
|
153
|
+
/** Modifier flags shared by logical-key and physical-code registrations. */
|
|
154
|
+
interface RawModifiers {
|
|
215
155
|
/** The non-modifier key (e.g., 'S', 'Escape', 'F1'). */
|
|
216
|
-
key: Key | (string & {});
|
|
217
156
|
/** Platform-adaptive modifier: Command on macOS, Control on Windows/Linux. Defaults to false. */
|
|
218
157
|
mod?: boolean;
|
|
219
158
|
/** Whether the Control key is required. Defaults to false. */
|
|
@@ -225,33 +164,18 @@ interface RawHotkey {
|
|
|
225
164
|
/** Whether the Meta (Command) key is required. Defaults to false. */
|
|
226
165
|
meta?: boolean;
|
|
227
166
|
}
|
|
167
|
+
type RawHotkey = ({
|
|
168
|
+
key: LogicalKey | (string & {});
|
|
169
|
+
code?: never;
|
|
170
|
+
} & RawModifiers) | ({
|
|
171
|
+
code: string;
|
|
172
|
+
key?: never;
|
|
173
|
+
} & RawModifiers);
|
|
228
174
|
/**
|
|
229
175
|
* A hotkey that can be passed to `HotkeyManager.register()` and `useHotkey()`.
|
|
230
176
|
* Either a type-safe string (`Hotkey`) or a raw object (`RawHotkey`).
|
|
231
177
|
*/
|
|
232
178
|
type RegisterableHotkey = Hotkey | RawHotkey;
|
|
233
|
-
/**
|
|
234
|
-
* Options for formatting hotkeys for display.
|
|
235
|
-
*/
|
|
236
|
-
interface FormatDisplayOptions {
|
|
237
|
-
/** The target platform. Defaults to auto-detection. */
|
|
238
|
-
platform?: 'mac' | 'windows' | 'linux';
|
|
239
|
-
/** Whether to use symbols for the display. Defaults to true. */
|
|
240
|
-
useSymbols?: boolean;
|
|
241
|
-
/** Override the separator between display tokens. Defaults to platform-specific formatting when null/undefined. */
|
|
242
|
-
separatorToken?: string | null;
|
|
243
|
-
}
|
|
244
|
-
/**
|
|
245
|
-
* Result of validating a hotkey string.
|
|
246
|
-
*/
|
|
247
|
-
interface ValidationResult {
|
|
248
|
-
/** Whether the hotkey is valid (can still have warnings) */
|
|
249
|
-
valid: boolean;
|
|
250
|
-
/** Warning messages about potential issues */
|
|
251
|
-
warnings: Array<string>;
|
|
252
|
-
/** Error messages about invalid syntax */
|
|
253
|
-
errors: Array<string>;
|
|
254
|
-
}
|
|
255
179
|
/**
|
|
256
180
|
* Context passed to hotkey callbacks along with the keyboard event.
|
|
257
181
|
*/
|
|
@@ -278,7 +202,7 @@ interface HotkeyCallbackContext {
|
|
|
278
202
|
type HotkeyCallback = (event: KeyboardEvent, context: HotkeyCallbackContext) => void;
|
|
279
203
|
/**
|
|
280
204
|
* Metadata for hotkey and sequence registrations.
|
|
281
|
-
* Includes `name` and `
|
|
205
|
+
* Includes `name`, `description`, and `group` by default. Extend via declaration merging:
|
|
282
206
|
*
|
|
283
207
|
* @example
|
|
284
208
|
* ```ts
|
|
@@ -295,7 +219,18 @@ interface HotkeyMeta {
|
|
|
295
219
|
name?: string;
|
|
296
220
|
/** Description of what this hotkey does */
|
|
297
221
|
description?: string;
|
|
222
|
+
/** Optional display group. Does not affect matching or scope. */
|
|
223
|
+
group?: string;
|
|
298
224
|
}
|
|
225
|
+
/**
|
|
226
|
+
* Behavior when registering a hotkey/sequence that conflicts with an existing registration.
|
|
227
|
+
*
|
|
228
|
+
* - `'warn'` - Log a warning to the console but allow both registrations (default)
|
|
229
|
+
* - `'error'` - Throw an error and prevent the new registration
|
|
230
|
+
* - `'replace'` - Unregister the existing registration and register the new one
|
|
231
|
+
* - `'allow'` - Allow multiple registrations without warning
|
|
232
|
+
*/
|
|
233
|
+
type ConflictBehavior = 'warn' | 'error' | 'replace' | 'allow';
|
|
299
234
|
//#endregion
|
|
300
|
-
export {
|
|
301
|
-
//# sourceMappingURL=hotkey.d.
|
|
235
|
+
export { ConflictBehavior, FourModifierHotkey, Hotkey, HotkeyCallback, HotkeyCallbackContext, HotkeyMeta, ParsedHotkey, ParsedModifiers, RawHotkey, RawModifiers, RegisterableHotkey, SingleModifierHotkey, ThreeModifierHotkey, TwoModifierHotkey };
|
|
236
|
+
//# sourceMappingURL=hotkey.types.d.ts.map
|
package/dist/index.cjs
CHANGED
|
@@ -1,14 +1,18 @@
|
|
|
1
1
|
Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
|
|
2
2
|
const require_constants = require('./constants.cjs');
|
|
3
|
+
const require_display_labels = require('./display-labels.cjs');
|
|
4
|
+
const require_platform = require('./platform.cjs');
|
|
3
5
|
const require_parse = require('./parse.cjs');
|
|
4
6
|
const require_format = require('./format.cjs');
|
|
7
|
+
const require_validate = require('./validate.cjs');
|
|
5
8
|
const require_match = require('./match.cjs');
|
|
9
|
+
const require_hint = require('./hint.cjs');
|
|
6
10
|
const require_hotkey_manager = require('./hotkey-manager.cjs');
|
|
11
|
+
const require_sequence_manager = require('./sequence-manager.cjs');
|
|
12
|
+
const require_conflicts = require('./conflicts.cjs');
|
|
7
13
|
const require_key_state_tracker = require('./key-state-tracker.cjs');
|
|
8
14
|
const require_hotkey_recorder = require('./hotkey-recorder.cjs');
|
|
9
15
|
const require_hotkey_sequence_recorder = require('./hotkey-sequence-recorder.cjs');
|
|
10
|
-
const require_sequence_manager = require('./sequence-manager.cjs');
|
|
11
|
-
const require_validate = require('./validate.cjs');
|
|
12
16
|
|
|
13
17
|
exports.ALL_KEYS = require_constants.ALL_KEYS;
|
|
14
18
|
exports.DEFAULT_SEQUENCE_TIMEOUT = require_sequence_manager.DEFAULT_SEQUENCE_TIMEOUT;
|
|
@@ -17,12 +21,12 @@ exports.FUNCTION_KEYS = require_constants.FUNCTION_KEYS;
|
|
|
17
21
|
exports.HotkeyManager = require_hotkey_manager.HotkeyManager;
|
|
18
22
|
exports.HotkeyRecorder = require_hotkey_recorder.HotkeyRecorder;
|
|
19
23
|
exports.HotkeySequenceRecorder = require_hotkey_sequence_recorder.HotkeySequenceRecorder;
|
|
20
|
-
exports.KEY_DISPLAY_SYMBOLS =
|
|
24
|
+
exports.KEY_DISPLAY_SYMBOLS = require_display_labels.KEY_DISPLAY_SYMBOLS;
|
|
21
25
|
exports.KeyStateTracker = require_key_state_tracker.KeyStateTracker;
|
|
22
26
|
exports.LETTER_KEYS = require_constants.LETTER_KEYS;
|
|
23
|
-
exports.LINUX_MODIFIER_LABELS =
|
|
24
|
-
exports.MAC_MODIFIER_LABELS =
|
|
25
|
-
exports.MAC_MODIFIER_SYMBOLS =
|
|
27
|
+
exports.LINUX_MODIFIER_LABELS = require_display_labels.LINUX_MODIFIER_LABELS;
|
|
28
|
+
exports.MAC_MODIFIER_LABELS = require_display_labels.MAC_MODIFIER_LABELS;
|
|
29
|
+
exports.MAC_MODIFIER_SYMBOLS = require_display_labels.MAC_MODIFIER_SYMBOLS;
|
|
26
30
|
exports.MODIFIER_ALIASES = require_constants.MODIFIER_ALIASES;
|
|
27
31
|
exports.MODIFIER_KEYS = require_constants.MODIFIER_KEYS;
|
|
28
32
|
exports.MODIFIER_ORDER = require_constants.MODIFIER_ORDER;
|
|
@@ -30,15 +34,17 @@ exports.NAVIGATION_KEYS = require_constants.NAVIGATION_KEYS;
|
|
|
30
34
|
exports.NUMBER_KEYS = require_constants.NUMBER_KEYS;
|
|
31
35
|
exports.PUNCTUATION_CODE_MAP = require_constants.PUNCTUATION_CODE_MAP;
|
|
32
36
|
exports.PUNCTUATION_KEYS = require_constants.PUNCTUATION_KEYS;
|
|
33
|
-
exports.PUNCTUATION_KEY_DISPLAY_LABELS =
|
|
37
|
+
exports.PUNCTUATION_KEY_DISPLAY_LABELS = require_display_labels.PUNCTUATION_KEY_DISPLAY_LABELS;
|
|
34
38
|
exports.SequenceManager = require_sequence_manager.SequenceManager;
|
|
35
|
-
exports.WINDOWS_MODIFIER_LABELS =
|
|
39
|
+
exports.WINDOWS_MODIFIER_LABELS = require_display_labels.WINDOWS_MODIFIER_LABELS;
|
|
40
|
+
exports.areHotkeysEqual = require_match.areHotkeysEqual;
|
|
36
41
|
exports.assertValidHotkey = require_validate.assertValidHotkey;
|
|
37
42
|
exports.checkHotkey = require_validate.checkHotkey;
|
|
38
43
|
exports.createHotkeyHandler = require_match.createHotkeyHandler;
|
|
39
44
|
exports.createMultiHotkeyHandler = require_match.createMultiHotkeyHandler;
|
|
40
45
|
exports.createSequenceMatcher = require_sequence_manager.createSequenceMatcher;
|
|
41
|
-
exports.detectPlatform =
|
|
46
|
+
exports.detectPlatform = require_platform.detectPlatform;
|
|
47
|
+
exports.findHotkeyConflicts = require_conflicts.findHotkeyConflicts;
|
|
42
48
|
exports.formatForDisplay = require_format.formatForDisplay;
|
|
43
49
|
exports.formatHotkey = require_format.formatHotkey;
|
|
44
50
|
exports.formatHotkeySequence = require_format.formatHotkeySequence;
|
|
@@ -49,6 +55,7 @@ exports.getSequenceManager = require_sequence_manager.getSequenceManager;
|
|
|
49
55
|
exports.hasNonModifierKey = require_parse.hasNonModifierKey;
|
|
50
56
|
exports.isModifierKey = require_parse.isModifierKey;
|
|
51
57
|
exports.isSingleLetterKey = require_constants.isSingleLetterKey;
|
|
58
|
+
exports.matchesHeldModifiers = require_hint.matchesHeldModifiers;
|
|
52
59
|
exports.matchesKeyboardEvent = require_match.matchesKeyboardEvent;
|
|
53
60
|
exports.normalizeHotkey = require_parse.normalizeHotkey;
|
|
54
61
|
exports.normalizeHotkeyFromEvent = require_parse.normalizeHotkeyFromEvent;
|
|
@@ -57,7 +64,8 @@ exports.normalizeKeyName = require_constants.normalizeKeyName;
|
|
|
57
64
|
exports.normalizeRegisterableHotkey = require_parse.normalizeRegisterableHotkey;
|
|
58
65
|
exports.parseHotkey = require_parse.parseHotkey;
|
|
59
66
|
exports.parseKeyboardEvent = require_parse.parseKeyboardEvent;
|
|
67
|
+
exports.parseRegisterableHotkey = require_parse.parseRegisterableHotkey;
|
|
60
68
|
exports.rawHotkeyToParsedHotkey = require_parse.rawHotkeyToParsedHotkey;
|
|
61
|
-
exports.resolveModifier =
|
|
69
|
+
exports.resolveModifier = require_platform.resolveModifier;
|
|
62
70
|
exports.toHotkeyRegistrationView = require_hotkey_manager.toHotkeyRegistrationView;
|
|
63
71
|
exports.validateHotkey = require_validate.validateHotkey;
|
package/dist/index.d.cts
CHANGED
|
@@ -1,13 +1,18 @@
|
|
|
1
|
-
import { CanonicalModifier, EditingKey,
|
|
2
|
-
import { ALL_KEYS, EDITING_KEYS, FUNCTION_KEYS,
|
|
3
|
-
import {
|
|
4
|
-
import {
|
|
1
|
+
import { CanonicalModifier, EditingKey, FunctionKey, IndividualKey, Key, LetterKey, LogicalKey, Modifier, NamedKey, NavigationKey, NonPunctuationKey, NormalizedKeyboardEvent, NumberKey, PhysicalKey, PhysicalKeyCode, PunctuationKey } from "./key.types.cjs";
|
|
2
|
+
import { ALL_KEYS, EDITING_KEYS, FUNCTION_KEYS, LETTER_KEYS, MODIFIER_ALIASES, MODIFIER_KEYS, MODIFIER_ORDER, NAVIGATION_KEYS, NUMBER_KEYS, PUNCTUATION_CODE_MAP, PUNCTUATION_KEYS, isSingleLetterKey, normalizeKeyName } from "./constants.cjs";
|
|
3
|
+
import { KEY_DISPLAY_SYMBOLS, LINUX_MODIFIER_LABELS, MAC_MODIFIER_LABELS, MAC_MODIFIER_SYMBOLS, PUNCTUATION_KEY_DISPLAY_LABELS, WINDOWS_MODIFIER_LABELS } from "./display-labels.cjs";
|
|
4
|
+
import { detectPlatform, resolveModifier } from "./platform.cjs";
|
|
5
|
+
import { ConflictBehavior, FourModifierHotkey, Hotkey, HotkeyCallback, HotkeyCallbackContext, HotkeyMeta, ParsedHotkey, ParsedModifiers, RawHotkey, RawModifiers, RegisterableHotkey, SingleModifierHotkey, ThreeModifierHotkey, TwoModifierHotkey } from "./hotkey.types.cjs";
|
|
6
|
+
import { DisplayHotkey, FormatDisplayOptions, formatForDisplay, formatHotkey, formatHotkeySequence, formatWithLabels } from "./format.cjs";
|
|
7
|
+
import { hasNonModifierKey, isModifierKey, normalizeHotkey, normalizeHotkeyFromEvent, normalizeHotkeyFromParsed, normalizeRegisterableHotkey, parseHotkey, parseKeyboardEvent, parseRegisterableHotkey, rawHotkeyToParsedHotkey } from "./parse.cjs";
|
|
8
|
+
import { ValidationResult, assertValidHotkey, checkHotkey, validateHotkey } from "./validate.cjs";
|
|
9
|
+
import { CreateHotkeyHandlerOptions, KeyboardEventMatch, MultiHotkeyHandler, areHotkeysEqual, createHotkeyHandler, createMultiHotkeyHandler, matchesKeyboardEvent } from "./match.cjs";
|
|
10
|
+
import { HeldModifierOptions, matchesHeldModifiers } from "./hint.cjs";
|
|
5
11
|
import { HotkeyManager, HotkeyOptions, HotkeyRegistration, HotkeyRegistrationHandle, HotkeyRegistrationView, getHotkeyManager, toHotkeyRegistrationView } from "./hotkey-manager.cjs";
|
|
12
|
+
import { DEFAULT_SEQUENCE_TIMEOUT, HotkeySequence, SequenceManager, SequenceOptions, SequenceRegistration, SequenceRegistrationHandle, SequenceRegistrationView, Target, createSequenceMatcher, getSequenceManager } from "./sequence-manager.cjs";
|
|
13
|
+
import { HotkeyConflict, HotkeyConflictOptions, findHotkeyConflicts } from "./conflicts.cjs";
|
|
6
14
|
import { KeyStateTracker, KeyStateTrackerState, getKeyStateTracker } from "./key-state-tracker.cjs";
|
|
7
|
-
import {
|
|
8
|
-
import { hasNonModifierKey, isModifierKey, normalizeHotkey, normalizeHotkeyFromEvent, normalizeHotkeyFromParsed, normalizeRegisterableHotkey, parseHotkey, parseKeyboardEvent, rawHotkeyToParsedHotkey } from "./parse.cjs";
|
|
15
|
+
import { HotkeyRecorderValidationContext, HotkeySequenceRecorderValidationContext, RecorderKeyMode, RecorderOptions, RecorderRejection } from "./recorder-options.cjs";
|
|
9
16
|
import { HotkeyRecorder, HotkeyRecorderOptions, HotkeyRecorderState } from "./hotkey-recorder.cjs";
|
|
10
|
-
import { DEFAULT_SEQUENCE_TIMEOUT, HotkeySequence, SequenceManager, SequenceOptions, SequenceRegistrationHandle, SequenceRegistrationView, createSequenceMatcher, getSequenceManager } from "./sequence-manager.cjs";
|
|
11
17
|
import { HotkeySequenceRecorder, HotkeySequenceRecorderCommitKeys, HotkeySequenceRecorderOptions, HotkeySequenceRecorderState } from "./hotkey-sequence-recorder.cjs";
|
|
12
|
-
|
|
13
|
-
export { ALL_KEYS, CanonicalModifier, ConflictBehavior, CreateHotkeyHandlerOptions, DEFAULT_SEQUENCE_TIMEOUT, EDITING_KEYS, EditingKey, FUNCTION_KEYS, FormatDisplayOptions, FunctionKey, Hotkey, HotkeyCallback, HotkeyCallbackContext, HotkeyManager, HotkeyMeta, HotkeyOptions, HotkeyRecorder, HotkeyRecorderOptions, HotkeyRecorderState, HotkeyRegistration, HotkeyRegistrationHandle, HotkeyRegistrationView, HotkeySequence, HotkeySequenceRecorder, HotkeySequenceRecorderCommitKeys, HotkeySequenceRecorderOptions, HotkeySequenceRecorderState, IndividualKey, KEY_DISPLAY_SYMBOLS, Key, KeyStateTracker, KeyStateTrackerState, LETTER_KEYS, LINUX_MODIFIER_LABELS, LetterKey, MAC_MODIFIER_LABELS, MAC_MODIFIER_SYMBOLS, MODIFIER_ALIASES, MODIFIER_KEYS, MODIFIER_ORDER, Modifier, NAVIGATION_KEYS, NUMBER_KEYS, NavigationKey, NumberKey, PUNCTUATION_CODE_MAP, PUNCTUATION_KEYS, PUNCTUATION_KEY_DISPLAY_LABELS, ParsedHotkey, PunctuationKey, RawHotkey, RegisterableHotkey, SequenceManager, SequenceOptions, SequenceRegistrationHandle, SequenceRegistrationView, ValidationResult, WINDOWS_MODIFIER_LABELS, 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 };
|
|
18
|
+
export { ALL_KEYS, CanonicalModifier, ConflictBehavior, CreateHotkeyHandlerOptions, DEFAULT_SEQUENCE_TIMEOUT, DisplayHotkey, EDITING_KEYS, EditingKey, FUNCTION_KEYS, FormatDisplayOptions, FourModifierHotkey, FunctionKey, HeldModifierOptions, Hotkey, HotkeyCallback, HotkeyCallbackContext, HotkeyConflict, HotkeyConflictOptions, HotkeyManager, HotkeyMeta, HotkeyOptions, HotkeyRecorder, HotkeyRecorderOptions, HotkeyRecorderState, HotkeyRecorderValidationContext, HotkeyRegistration, HotkeyRegistrationHandle, HotkeyRegistrationView, HotkeySequence, HotkeySequenceRecorder, HotkeySequenceRecorderCommitKeys, HotkeySequenceRecorderOptions, HotkeySequenceRecorderState, HotkeySequenceRecorderValidationContext, IndividualKey, KEY_DISPLAY_SYMBOLS, Key, KeyStateTracker, KeyStateTrackerState, KeyboardEventMatch, LETTER_KEYS, LINUX_MODIFIER_LABELS, LetterKey, LogicalKey, MAC_MODIFIER_LABELS, MAC_MODIFIER_SYMBOLS, MODIFIER_ALIASES, MODIFIER_KEYS, MODIFIER_ORDER, Modifier, MultiHotkeyHandler, NAVIGATION_KEYS, NUMBER_KEYS, NamedKey, NavigationKey, NonPunctuationKey, NormalizedKeyboardEvent, NumberKey, PUNCTUATION_CODE_MAP, PUNCTUATION_KEYS, PUNCTUATION_KEY_DISPLAY_LABELS, ParsedHotkey, ParsedModifiers, PhysicalKey, PhysicalKeyCode, PunctuationKey, RawHotkey, RawModifiers, RecorderKeyMode, RecorderOptions, RecorderRejection, RegisterableHotkey, SequenceManager, SequenceOptions, SequenceRegistration, SequenceRegistrationHandle, SequenceRegistrationView, SingleModifierHotkey, Target, ThreeModifierHotkey, TwoModifierHotkey, ValidationResult, WINDOWS_MODIFIER_LABELS, 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 };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,13 +1,18 @@
|
|
|
1
|
-
import { CanonicalModifier, EditingKey,
|
|
2
|
-
import { ALL_KEYS, EDITING_KEYS, FUNCTION_KEYS,
|
|
3
|
-
import {
|
|
4
|
-
import {
|
|
1
|
+
import { CanonicalModifier, EditingKey, FunctionKey, IndividualKey, Key, LetterKey, LogicalKey, Modifier, NamedKey, NavigationKey, NonPunctuationKey, NormalizedKeyboardEvent, NumberKey, PhysicalKey, PhysicalKeyCode, PunctuationKey } from "./key.types.js";
|
|
2
|
+
import { ALL_KEYS, EDITING_KEYS, FUNCTION_KEYS, LETTER_KEYS, MODIFIER_ALIASES, MODIFIER_KEYS, MODIFIER_ORDER, NAVIGATION_KEYS, NUMBER_KEYS, PUNCTUATION_CODE_MAP, PUNCTUATION_KEYS, isSingleLetterKey, normalizeKeyName } from "./constants.js";
|
|
3
|
+
import { KEY_DISPLAY_SYMBOLS, LINUX_MODIFIER_LABELS, MAC_MODIFIER_LABELS, MAC_MODIFIER_SYMBOLS, PUNCTUATION_KEY_DISPLAY_LABELS, WINDOWS_MODIFIER_LABELS } from "./display-labels.js";
|
|
4
|
+
import { detectPlatform, resolveModifier } from "./platform.js";
|
|
5
|
+
import { ConflictBehavior, FourModifierHotkey, Hotkey, HotkeyCallback, HotkeyCallbackContext, HotkeyMeta, ParsedHotkey, ParsedModifiers, RawHotkey, RawModifiers, RegisterableHotkey, SingleModifierHotkey, ThreeModifierHotkey, TwoModifierHotkey } from "./hotkey.types.js";
|
|
6
|
+
import { DisplayHotkey, FormatDisplayOptions, formatForDisplay, formatHotkey, formatHotkeySequence, formatWithLabels } from "./format.js";
|
|
7
|
+
import { hasNonModifierKey, isModifierKey, normalizeHotkey, normalizeHotkeyFromEvent, normalizeHotkeyFromParsed, normalizeRegisterableHotkey, parseHotkey, parseKeyboardEvent, parseRegisterableHotkey, rawHotkeyToParsedHotkey } from "./parse.js";
|
|
8
|
+
import { ValidationResult, assertValidHotkey, checkHotkey, validateHotkey } from "./validate.js";
|
|
9
|
+
import { CreateHotkeyHandlerOptions, KeyboardEventMatch, MultiHotkeyHandler, areHotkeysEqual, createHotkeyHandler, createMultiHotkeyHandler, matchesKeyboardEvent } from "./match.js";
|
|
10
|
+
import { HeldModifierOptions, matchesHeldModifiers } from "./hint.js";
|
|
5
11
|
import { HotkeyManager, HotkeyOptions, HotkeyRegistration, HotkeyRegistrationHandle, HotkeyRegistrationView, getHotkeyManager, toHotkeyRegistrationView } from "./hotkey-manager.js";
|
|
12
|
+
import { DEFAULT_SEQUENCE_TIMEOUT, HotkeySequence, SequenceManager, SequenceOptions, SequenceRegistration, SequenceRegistrationHandle, SequenceRegistrationView, Target, createSequenceMatcher, getSequenceManager } from "./sequence-manager.js";
|
|
13
|
+
import { HotkeyConflict, HotkeyConflictOptions, findHotkeyConflicts } from "./conflicts.js";
|
|
6
14
|
import { KeyStateTracker, KeyStateTrackerState, getKeyStateTracker } from "./key-state-tracker.js";
|
|
7
|
-
import {
|
|
8
|
-
import { hasNonModifierKey, isModifierKey, normalizeHotkey, normalizeHotkeyFromEvent, normalizeHotkeyFromParsed, normalizeRegisterableHotkey, parseHotkey, parseKeyboardEvent, rawHotkeyToParsedHotkey } from "./parse.js";
|
|
15
|
+
import { HotkeyRecorderValidationContext, HotkeySequenceRecorderValidationContext, RecorderKeyMode, RecorderOptions, RecorderRejection } from "./recorder-options.js";
|
|
9
16
|
import { HotkeyRecorder, HotkeyRecorderOptions, HotkeyRecorderState } from "./hotkey-recorder.js";
|
|
10
|
-
import { DEFAULT_SEQUENCE_TIMEOUT, HotkeySequence, SequenceManager, SequenceOptions, SequenceRegistrationHandle, SequenceRegistrationView, createSequenceMatcher, getSequenceManager } from "./sequence-manager.js";
|
|
11
17
|
import { HotkeySequenceRecorder, HotkeySequenceRecorderCommitKeys, HotkeySequenceRecorderOptions, HotkeySequenceRecorderState } from "./hotkey-sequence-recorder.js";
|
|
12
|
-
|
|
13
|
-
export { ALL_KEYS, CanonicalModifier, ConflictBehavior, CreateHotkeyHandlerOptions, DEFAULT_SEQUENCE_TIMEOUT, EDITING_KEYS, EditingKey, FUNCTION_KEYS, FormatDisplayOptions, FunctionKey, Hotkey, HotkeyCallback, HotkeyCallbackContext, HotkeyManager, HotkeyMeta, HotkeyOptions, HotkeyRecorder, HotkeyRecorderOptions, HotkeyRecorderState, HotkeyRegistration, HotkeyRegistrationHandle, HotkeyRegistrationView, HotkeySequence, HotkeySequenceRecorder, HotkeySequenceRecorderCommitKeys, HotkeySequenceRecorderOptions, HotkeySequenceRecorderState, IndividualKey, KEY_DISPLAY_SYMBOLS, Key, KeyStateTracker, KeyStateTrackerState, LETTER_KEYS, LINUX_MODIFIER_LABELS, LetterKey, MAC_MODIFIER_LABELS, MAC_MODIFIER_SYMBOLS, MODIFIER_ALIASES, MODIFIER_KEYS, MODIFIER_ORDER, Modifier, NAVIGATION_KEYS, NUMBER_KEYS, NavigationKey, NumberKey, PUNCTUATION_CODE_MAP, PUNCTUATION_KEYS, PUNCTUATION_KEY_DISPLAY_LABELS, ParsedHotkey, PunctuationKey, RawHotkey, RegisterableHotkey, SequenceManager, SequenceOptions, SequenceRegistrationHandle, SequenceRegistrationView, ValidationResult, WINDOWS_MODIFIER_LABELS, 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 };
|
|
18
|
+
export { ALL_KEYS, CanonicalModifier, ConflictBehavior, CreateHotkeyHandlerOptions, DEFAULT_SEQUENCE_TIMEOUT, DisplayHotkey, EDITING_KEYS, EditingKey, FUNCTION_KEYS, FormatDisplayOptions, FourModifierHotkey, FunctionKey, HeldModifierOptions, Hotkey, HotkeyCallback, HotkeyCallbackContext, HotkeyConflict, HotkeyConflictOptions, HotkeyManager, HotkeyMeta, HotkeyOptions, HotkeyRecorder, HotkeyRecorderOptions, HotkeyRecorderState, HotkeyRecorderValidationContext, HotkeyRegistration, HotkeyRegistrationHandle, HotkeyRegistrationView, HotkeySequence, HotkeySequenceRecorder, HotkeySequenceRecorderCommitKeys, HotkeySequenceRecorderOptions, HotkeySequenceRecorderState, HotkeySequenceRecorderValidationContext, IndividualKey, KEY_DISPLAY_SYMBOLS, Key, KeyStateTracker, KeyStateTrackerState, KeyboardEventMatch, LETTER_KEYS, LINUX_MODIFIER_LABELS, LetterKey, LogicalKey, MAC_MODIFIER_LABELS, MAC_MODIFIER_SYMBOLS, MODIFIER_ALIASES, MODIFIER_KEYS, MODIFIER_ORDER, Modifier, MultiHotkeyHandler, NAVIGATION_KEYS, NUMBER_KEYS, NamedKey, NavigationKey, NonPunctuationKey, NormalizedKeyboardEvent, NumberKey, PUNCTUATION_CODE_MAP, PUNCTUATION_KEYS, PUNCTUATION_KEY_DISPLAY_LABELS, ParsedHotkey, ParsedModifiers, PhysicalKey, PhysicalKeyCode, PunctuationKey, RawHotkey, RawModifiers, RecorderKeyMode, RecorderOptions, RecorderRejection, RegisterableHotkey, SequenceManager, SequenceOptions, SequenceRegistration, SequenceRegistrationHandle, SequenceRegistrationView, SingleModifierHotkey, Target, ThreeModifierHotkey, TwoModifierHotkey, ValidationResult, WINDOWS_MODIFIER_LABELS, 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 };
|
package/dist/index.js
CHANGED
|
@@ -1,12 +1,16 @@
|
|
|
1
|
-
import { ALL_KEYS, EDITING_KEYS, FUNCTION_KEYS,
|
|
2
|
-
import {
|
|
1
|
+
import { ALL_KEYS, EDITING_KEYS, FUNCTION_KEYS, LETTER_KEYS, MODIFIER_ALIASES, MODIFIER_KEYS, MODIFIER_ORDER, NAVIGATION_KEYS, NUMBER_KEYS, PUNCTUATION_CODE_MAP, PUNCTUATION_KEYS, isSingleLetterKey, normalizeKeyName } from "./constants.js";
|
|
2
|
+
import { KEY_DISPLAY_SYMBOLS, LINUX_MODIFIER_LABELS, MAC_MODIFIER_LABELS, MAC_MODIFIER_SYMBOLS, PUNCTUATION_KEY_DISPLAY_LABELS, WINDOWS_MODIFIER_LABELS } from "./display-labels.js";
|
|
3
|
+
import { detectPlatform, resolveModifier } from "./platform.js";
|
|
4
|
+
import { hasNonModifierKey, isModifierKey, normalizeHotkey, normalizeHotkeyFromEvent, normalizeHotkeyFromParsed, normalizeRegisterableHotkey, parseHotkey, parseKeyboardEvent, parseRegisterableHotkey, rawHotkeyToParsedHotkey } from "./parse.js";
|
|
3
5
|
import { formatForDisplay, formatHotkey, formatHotkeySequence, formatWithLabels } from "./format.js";
|
|
4
|
-
import {
|
|
6
|
+
import { assertValidHotkey, checkHotkey, validateHotkey } from "./validate.js";
|
|
7
|
+
import { areHotkeysEqual, createHotkeyHandler, createMultiHotkeyHandler, matchesKeyboardEvent } from "./match.js";
|
|
8
|
+
import { matchesHeldModifiers } from "./hint.js";
|
|
5
9
|
import { HotkeyManager, getHotkeyManager, toHotkeyRegistrationView } from "./hotkey-manager.js";
|
|
10
|
+
import { DEFAULT_SEQUENCE_TIMEOUT, SequenceManager, createSequenceMatcher, getSequenceManager } from "./sequence-manager.js";
|
|
11
|
+
import { findHotkeyConflicts } from "./conflicts.js";
|
|
6
12
|
import { KeyStateTracker, getKeyStateTracker } from "./key-state-tracker.js";
|
|
7
13
|
import { HotkeyRecorder } from "./hotkey-recorder.js";
|
|
8
14
|
import { HotkeySequenceRecorder } from "./hotkey-sequence-recorder.js";
|
|
9
|
-
import { DEFAULT_SEQUENCE_TIMEOUT, SequenceManager, createSequenceMatcher, getSequenceManager } from "./sequence-manager.js";
|
|
10
|
-
import { assertValidHotkey, checkHotkey, validateHotkey } from "./validate.js";
|
|
11
15
|
|
|
12
|
-
export { ALL_KEYS, DEFAULT_SEQUENCE_TIMEOUT, EDITING_KEYS, FUNCTION_KEYS, HotkeyManager, HotkeyRecorder, HotkeySequenceRecorder, KEY_DISPLAY_SYMBOLS, KeyStateTracker, 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_KEYS, PUNCTUATION_KEY_DISPLAY_LABELS, SequenceManager, WINDOWS_MODIFIER_LABELS, 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 };
|
|
16
|
+
export { ALL_KEYS, DEFAULT_SEQUENCE_TIMEOUT, EDITING_KEYS, FUNCTION_KEYS, HotkeyManager, HotkeyRecorder, HotkeySequenceRecorder, KEY_DISPLAY_SYMBOLS, KeyStateTracker, 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_KEYS, PUNCTUATION_KEY_DISPLAY_LABELS, SequenceManager, WINDOWS_MODIFIER_LABELS, 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 };
|
|
@@ -47,8 +47,7 @@ function getDefaultKeyStateTrackerState() {
|
|
|
47
47
|
*/
|
|
48
48
|
var KeyStateTracker = class KeyStateTracker {
|
|
49
49
|
static #instance = null;
|
|
50
|
-
#
|
|
51
|
-
#heldCodesMap = /* @__PURE__ */ new Map();
|
|
50
|
+
#heldEntries = /* @__PURE__ */ new Map();
|
|
52
51
|
#keydownListener = null;
|
|
53
52
|
#keyupListener = null;
|
|
54
53
|
#blurListener = null;
|
|
@@ -79,44 +78,46 @@ var KeyStateTracker = class KeyStateTracker {
|
|
|
79
78
|
if (typeof document === "undefined") return;
|
|
80
79
|
this.#keydownListener = (event) => {
|
|
81
80
|
const key = require_constants.normalizeKeyName(event.key);
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
this.#
|
|
81
|
+
const identity = event.code || `key:${key}`;
|
|
82
|
+
if (!this.#heldEntries.has(identity)) {
|
|
83
|
+
this.#heldEntries.set(identity, {
|
|
84
|
+
key,
|
|
85
|
+
code: event.code
|
|
86
|
+
});
|
|
85
87
|
this.#syncState();
|
|
86
88
|
}
|
|
87
89
|
};
|
|
88
90
|
this.#keyupListener = (event) => {
|
|
89
91
|
const key = require_constants.normalizeKeyName(event.key);
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
92
|
+
const identity = event.code || `key:${key}`;
|
|
93
|
+
this.#heldEntries.delete(identity);
|
|
94
|
+
if (!event.code) {
|
|
95
|
+
for (const [entryIdentity, entry] of this.#heldEntries) if (entry.key === key) this.#heldEntries.delete(entryIdentity);
|
|
93
96
|
}
|
|
94
97
|
if (require_constants.MODIFIER_KEYS.has(key)) {
|
|
95
|
-
for (const
|
|
96
|
-
this.#heldKeysSet.delete(heldKey);
|
|
97
|
-
this.#heldCodesMap.delete(heldKey);
|
|
98
|
-
}
|
|
98
|
+
for (const [entryIdentity, entry] of this.#heldEntries) if (!require_constants.MODIFIER_KEYS.has(entry.key)) this.#heldEntries.delete(entryIdentity);
|
|
99
99
|
}
|
|
100
100
|
this.#syncState();
|
|
101
101
|
};
|
|
102
102
|
this.#blurListener = () => {
|
|
103
|
-
if (this.#
|
|
104
|
-
this.#
|
|
105
|
-
this.#heldCodesMap.clear();
|
|
103
|
+
if (this.#heldEntries.size > 0) {
|
|
104
|
+
this.#heldEntries.clear();
|
|
106
105
|
this.#syncState();
|
|
107
106
|
}
|
|
108
107
|
};
|
|
109
|
-
document.addEventListener("keydown", this.#keydownListener);
|
|
110
|
-
document.addEventListener("keyup", this.#keyupListener);
|
|
108
|
+
document.addEventListener("keydown", this.#keydownListener, true);
|
|
109
|
+
document.addEventListener("keyup", this.#keyupListener, true);
|
|
111
110
|
window.addEventListener("blur", this.#blurListener);
|
|
112
111
|
}
|
|
113
112
|
/**
|
|
114
113
|
* Syncs the internal Set to the Store state.
|
|
115
114
|
*/
|
|
116
115
|
#syncState() {
|
|
116
|
+
const heldKeys = Array.from(new Set(Array.from(this.#heldEntries.values(), (entry) => entry.key)));
|
|
117
|
+
const heldCodes = Object.fromEntries(Array.from(this.#heldEntries.values(), (entry) => [entry.key, entry.code]));
|
|
117
118
|
this.store.setState(() => ({
|
|
118
|
-
heldKeys
|
|
119
|
-
heldCodes
|
|
119
|
+
heldKeys,
|
|
120
|
+
heldCodes
|
|
120
121
|
}));
|
|
121
122
|
}
|
|
122
123
|
/**
|
|
@@ -125,11 +126,11 @@ var KeyStateTracker = class KeyStateTracker {
|
|
|
125
126
|
#removeListeners() {
|
|
126
127
|
if (typeof document === "undefined") return;
|
|
127
128
|
if (this.#keydownListener) {
|
|
128
|
-
document.removeEventListener("keydown", this.#keydownListener);
|
|
129
|
+
document.removeEventListener("keydown", this.#keydownListener, true);
|
|
129
130
|
this.#keydownListener = null;
|
|
130
131
|
}
|
|
131
132
|
if (this.#keyupListener) {
|
|
132
|
-
document.removeEventListener("keyup", this.#keyupListener);
|
|
133
|
+
document.removeEventListener("keyup", this.#keyupListener, true);
|
|
133
134
|
this.#keyupListener = null;
|
|
134
135
|
}
|
|
135
136
|
if (this.#blurListener) {
|
|
@@ -153,7 +154,7 @@ var KeyStateTracker = class KeyStateTracker {
|
|
|
153
154
|
*/
|
|
154
155
|
isKeyHeld(key) {
|
|
155
156
|
const normalizedKey = require_constants.normalizeKeyName(key);
|
|
156
|
-
return this.#
|
|
157
|
+
return Array.from(this.#heldEntries.values()).some((entry) => entry.key === normalizedKey);
|
|
157
158
|
}
|
|
158
159
|
/**
|
|
159
160
|
* Checks if any of the given keys are currently held.
|
|
@@ -178,8 +179,7 @@ var KeyStateTracker = class KeyStateTracker {
|
|
|
178
179
|
*/
|
|
179
180
|
destroy() {
|
|
180
181
|
this.#removeListeners();
|
|
181
|
-
this.#
|
|
182
|
-
this.#heldCodesMap.clear();
|
|
182
|
+
this.#heldEntries.clear();
|
|
183
183
|
this.store.setState(() => getDefaultKeyStateTrackerState());
|
|
184
184
|
}
|
|
185
185
|
};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"key-state-tracker.cjs","names":["#instance","Store","#setupListeners","#keydownListener","normalizeKeyName","#heldKeysSet","#heldCodesMap","#syncState","#keyupListener","MODIFIER_KEYS","#blurListener","#removeListeners"],"sources":["../src/key-state-tracker.ts"],"sourcesContent":["import { Store } from '@tanstack/store'\nimport { MODIFIER_KEYS, normalizeKeyName } from './constants'\n\n/**\n * State interface for the KeyStateTracker.\n */\nexport interface KeyStateTrackerState {\n /**\n * Array of currently held key names (normalized, e.g. \"Control\", \"A\").\n */\n heldKeys: Array<string>\n /**\n * Map from normalized key name to the physical `event.code` (e.g. \"KeyA\", \"ShiftLeft\").\n * Useful for debugging which physical key was pressed.\n */\n heldCodes: Record<string, string>\n}\n\n/**\n * Returns the default state for KeyStateTracker.\n */\nfunction getDefaultKeyStateTrackerState(): KeyStateTrackerState {\n return {\n heldKeys: [],\n heldCodes: {},\n }\n}\n\n/**\n * Singleton tracker for currently held keyboard keys.\n *\n * This class maintains a list of all keys currently being pressed,\n * which is useful for:\n * - Displaying currently held keys to users\n * - Custom shortcut recording for rebinding\n * - Complex chord detection\n *\n * State Management:\n * - Uses TanStack Store for reactive state management\n * - State can be accessed via `tracker.store.state` when using the class directly\n * - When using framework adapters (React), use `useHeldKeys` and `useHeldKeyCodes` hooks for reactive state\n *\n * @example\n * ```ts\n * const tracker = KeyStateTracker.getInstance()\n *\n * // Access state directly\n * console.log(tracker.store.state.heldKeys) // ['Control', 'Shift']\n *\n * // Subscribe to changes with TanStack Store\n * const unsubscribe = tracker.store.subscribe(() => {\n * console.log('Currently held:', tracker.store.state.heldKeys)\n * })\n *\n * // Check current state\n * console.log(tracker.getHeldKeys()) // ['Control', 'Shift']\n * console.log(tracker.isKeyHeld('Control')) // true\n *\n * // Cleanup\n * unsubscribe()\n * ```\n */\nexport class KeyStateTracker {\n static #instance: KeyStateTracker | null = null\n\n /**\n * The TanStack Store instance containing the tracker state.\n * Use this to subscribe to state changes or access current state.\n */\n readonly store: Store<KeyStateTrackerState> = new Store(\n getDefaultKeyStateTrackerState(),\n )\n\n #heldKeysSet: Set<string> = new Set()\n #heldCodesMap: Map<string, string> = new Map()\n #keydownListener: ((event: KeyboardEvent) => void) | null = null\n #keyupListener: ((event: KeyboardEvent) => void) | null = null\n #blurListener: (() => void) | null = null\n\n private constructor() {\n this.#setupListeners()\n }\n\n /**\n * Gets the singleton instance of KeyStateTracker.\n */\n static getInstance(): KeyStateTracker {\n if (!KeyStateTracker.#instance) {\n KeyStateTracker.#instance = new KeyStateTracker()\n }\n return KeyStateTracker.#instance\n }\n\n /**\n * Resets the singleton instance. Useful for testing.\n */\n static resetInstance(): void {\n if (KeyStateTracker.#instance) {\n KeyStateTracker.#instance.destroy()\n KeyStateTracker.#instance = null\n }\n }\n\n /**\n * Sets up the keyboard event listeners.\n */\n #setupListeners(): void {\n if (typeof document === 'undefined') {\n return // SSR safety\n }\n\n this.#keydownListener = (event: KeyboardEvent) => {\n const key = normalizeKeyName(event.key)\n if (!this.#heldKeysSet.has(key)) {\n this.#heldKeysSet.add(key)\n this.#heldCodesMap.set(key, event.code)\n this.#syncState()\n }\n }\n\n this.#keyupListener = (event: KeyboardEvent) => {\n const key = normalizeKeyName(event.key)\n if (this.#heldKeysSet.has(key)) {\n this.#heldKeysSet.delete(key)\n this.#heldCodesMap.delete(key)\n }\n\n // When a modifier key is released, clear any non-modifier keys still\n // marked as held. On macOS, the OS intercepts modifier+key combos\n // (e.g. Cmd+S) and swallows the keyup event for the non-modifier key,\n // leaving it permanently stuck in the held set.\n if (MODIFIER_KEYS.has(key)) {\n for (const heldKey of this.#heldKeysSet) {\n if (!MODIFIER_KEYS.has(heldKey)) {\n this.#heldKeysSet.delete(heldKey)\n this.#heldCodesMap.delete(heldKey)\n }\n }\n }\n\n this.#syncState()\n }\n\n // Clear all keys when window loses focus (keys might be released while not focused)\n this.#blurListener = () => {\n if (this.#heldKeysSet.size > 0) {\n this.#heldKeysSet.clear()\n this.#heldCodesMap.clear()\n this.#syncState()\n }\n }\n\n document.addEventListener('keydown', this.#keydownListener)\n document.addEventListener('keyup', this.#keyupListener)\n window.addEventListener('blur', this.#blurListener)\n }\n\n /**\n * Syncs the internal Set to the Store state.\n */\n #syncState(): void {\n this.store.setState(() => ({\n heldKeys: Array.from(this.#heldKeysSet),\n heldCodes: Object.fromEntries(this.#heldCodesMap),\n }))\n }\n\n /**\n * Removes the keyboard event listeners.\n */\n #removeListeners(): void {\n if (typeof document === 'undefined') {\n return\n }\n\n if (this.#keydownListener) {\n document.removeEventListener('keydown', this.#keydownListener)\n this.#keydownListener = null\n }\n\n if (this.#keyupListener) {\n document.removeEventListener('keyup', this.#keyupListener)\n this.#keyupListener = null\n }\n\n if (this.#blurListener) {\n window.removeEventListener('blur', this.#blurListener)\n this.#blurListener = null\n }\n }\n\n /**\n * Gets an array of currently held key names.\n *\n * @returns Array of key names currently being pressed\n */\n getHeldKeys(): Array<string> {\n return this.store.state.heldKeys\n }\n\n /**\n * Checks if a specific key is currently being held.\n *\n * @param key - The key name to check (case-insensitive)\n * @returns True if the key is currently held\n */\n isKeyHeld(key: string): boolean {\n const normalizedKey = normalizeKeyName(key)\n return this.#heldKeysSet.has(normalizedKey)\n }\n\n /**\n * Checks if any of the given keys are currently held.\n *\n * @param keys - Array of key names to check\n * @returns True if any of the keys are currently held\n */\n isAnyKeyHeld(keys: Array<string>): boolean {\n return keys.some((key) => this.isKeyHeld(key))\n }\n\n /**\n * Checks if all of the given keys are currently held.\n *\n * @param keys - Array of key names to check\n * @returns True if all of the keys are currently held\n */\n areAllKeysHeld(keys: Array<string>): boolean {\n return keys.every((key) => this.isKeyHeld(key))\n }\n\n /**\n * Destroys the tracker and removes all listeners.\n */\n destroy(): void {\n this.#removeListeners()\n this.#heldKeysSet.clear()\n this.#heldCodesMap.clear()\n this.store.setState(() => getDefaultKeyStateTrackerState())\n }\n}\n\n/**\n * Gets the singleton KeyStateTracker instance.\n * Convenience function for accessing the tracker.\n */\nexport function getKeyStateTracker(): KeyStateTracker {\n return KeyStateTracker.getInstance()\n}\n"],"mappings":";;;;;;;AAqBA,SAAS,iCAAuD;AAC9D,QAAO;EACL,UAAU,EAAE;EACZ,WAAW,EAAE;EACd;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqCH,IAAa,kBAAb,MAAa,gBAAgB;CAC3B,QAAOA,WAAoC;CAU3C,+BAA4B,IAAI,KAAK;CACrC,gCAAqC,IAAI,KAAK;CAC9C,mBAA4D;CAC5D,iBAA0D;CAC1D,gBAAqC;CAErC,AAAQ,cAAc;eAVwB,IAAIC,sBAChD,gCAAgC,CACjC;AASC,QAAKC,gBAAiB;;;;;CAMxB,OAAO,cAA+B;AACpC,MAAI,CAAC,iBAAgBF,SACnB,kBAAgBA,WAAY,IAAI,iBAAiB;AAEnD,SAAO,iBAAgBA;;;;;CAMzB,OAAO,gBAAsB;AAC3B,MAAI,iBAAgBA,UAAW;AAC7B,oBAAgBA,SAAU,SAAS;AACnC,oBAAgBA,WAAY;;;;;;CAOhC,kBAAwB;AACtB,MAAI,OAAO,aAAa,YACtB;AAGF,QAAKG,mBAAoB,UAAyB;GAChD,MAAM,MAAMC,mCAAiB,MAAM,IAAI;AACvC,OAAI,CAAC,MAAKC,YAAa,IAAI,IAAI,EAAE;AAC/B,UAAKA,YAAa,IAAI,IAAI;AAC1B,UAAKC,aAAc,IAAI,KAAK,MAAM,KAAK;AACvC,UAAKC,WAAY;;;AAIrB,QAAKC,iBAAkB,UAAyB;GAC9C,MAAM,MAAMJ,mCAAiB,MAAM,IAAI;AACvC,OAAI,MAAKC,YAAa,IAAI,IAAI,EAAE;AAC9B,UAAKA,YAAa,OAAO,IAAI;AAC7B,UAAKC,aAAc,OAAO,IAAI;;AAOhC,OAAIG,gCAAc,IAAI,IAAI,EACxB;SAAK,MAAM,WAAW,MAAKJ,YACzB,KAAI,CAACI,gCAAc,IAAI,QAAQ,EAAE;AAC/B,WAAKJ,YAAa,OAAO,QAAQ;AACjC,WAAKC,aAAc,OAAO,QAAQ;;;AAKxC,SAAKC,WAAY;;AAInB,QAAKG,qBAAsB;AACzB,OAAI,MAAKL,YAAa,OAAO,GAAG;AAC9B,UAAKA,YAAa,OAAO;AACzB,UAAKC,aAAc,OAAO;AAC1B,UAAKC,WAAY;;;AAIrB,WAAS,iBAAiB,WAAW,MAAKJ,gBAAiB;AAC3D,WAAS,iBAAiB,SAAS,MAAKK,cAAe;AACvD,SAAO,iBAAiB,QAAQ,MAAKE,aAAc;;;;;CAMrD,aAAmB;AACjB,OAAK,MAAM,gBAAgB;GACzB,UAAU,MAAM,KAAK,MAAKL,YAAa;GACvC,WAAW,OAAO,YAAY,MAAKC,aAAc;GAClD,EAAE;;;;;CAML,mBAAyB;AACvB,MAAI,OAAO,aAAa,YACtB;AAGF,MAAI,MAAKH,iBAAkB;AACzB,YAAS,oBAAoB,WAAW,MAAKA,gBAAiB;AAC9D,SAAKA,kBAAmB;;AAG1B,MAAI,MAAKK,eAAgB;AACvB,YAAS,oBAAoB,SAAS,MAAKA,cAAe;AAC1D,SAAKA,gBAAiB;;AAGxB,MAAI,MAAKE,cAAe;AACtB,UAAO,oBAAoB,QAAQ,MAAKA,aAAc;AACtD,SAAKA,eAAgB;;;;;;;;CASzB,cAA6B;AAC3B,SAAO,KAAK,MAAM,MAAM;;;;;;;;CAS1B,UAAU,KAAsB;EAC9B,MAAM,gBAAgBN,mCAAiB,IAAI;AAC3C,SAAO,MAAKC,YAAa,IAAI,cAAc;;;;;;;;CAS7C,aAAa,MAA8B;AACzC,SAAO,KAAK,MAAM,QAAQ,KAAK,UAAU,IAAI,CAAC;;;;;;;;CAShD,eAAe,MAA8B;AAC3C,SAAO,KAAK,OAAO,QAAQ,KAAK,UAAU,IAAI,CAAC;;;;;CAMjD,UAAgB;AACd,QAAKM,iBAAkB;AACvB,QAAKN,YAAa,OAAO;AACzB,QAAKC,aAAc,OAAO;AAC1B,OAAK,MAAM,eAAe,gCAAgC,CAAC;;;;;;;AAQ/D,SAAgB,qBAAsC;AACpD,QAAO,gBAAgB,aAAa"}
|
|
1
|
+
{"version":3,"file":"key-state-tracker.cjs","names":["#instance","Store","#setupListeners","#keydownListener","normalizeKeyName","#heldEntries","#syncState","#keyupListener","MODIFIER_KEYS","#blurListener","#removeListeners"],"sources":["../src/key-state-tracker.ts"],"sourcesContent":["import { Store } from '@tanstack/store'\nimport { MODIFIER_KEYS, normalizeKeyName } from './constants'\n\n/**\n * State interface for the KeyStateTracker.\n */\nexport interface KeyStateTrackerState {\n /**\n * Array of currently held key names (normalized, e.g. \"Control\", \"A\").\n */\n heldKeys: Array<string>\n /**\n * Map from normalized key name to the physical `event.code` (e.g. \"KeyA\", \"ShiftLeft\").\n * Useful for debugging which physical key was pressed.\n */\n heldCodes: Record<string, string>\n}\n\n/**\n * Returns the default state for KeyStateTracker.\n */\nfunction getDefaultKeyStateTrackerState(): KeyStateTrackerState {\n return {\n heldKeys: [],\n heldCodes: {},\n }\n}\n\n/**\n * Singleton tracker for currently held keyboard keys.\n *\n * This class maintains a list of all keys currently being pressed,\n * which is useful for:\n * - Displaying currently held keys to users\n * - Custom shortcut recording for rebinding\n * - Complex chord detection\n *\n * State Management:\n * - Uses TanStack Store for reactive state management\n * - State can be accessed via `tracker.store.state` when using the class directly\n * - When using framework adapters (React), use `useHeldKeys` and `useHeldKeyCodes` hooks for reactive state\n *\n * @example\n * ```ts\n * const tracker = KeyStateTracker.getInstance()\n *\n * // Access state directly\n * console.log(tracker.store.state.heldKeys) // ['Control', 'Shift']\n *\n * // Subscribe to changes with TanStack Store\n * const unsubscribe = tracker.store.subscribe(() => {\n * console.log('Currently held:', tracker.store.state.heldKeys)\n * })\n *\n * // Check current state\n * console.log(tracker.getHeldKeys()) // ['Control', 'Shift']\n * console.log(tracker.isKeyHeld('Control')) // true\n *\n * // Cleanup\n * unsubscribe()\n * ```\n */\nexport class KeyStateTracker {\n static #instance: KeyStateTracker | null = null\n\n /**\n * The TanStack Store instance containing the tracker state.\n * Use this to subscribe to state changes or access current state.\n */\n readonly store: Store<KeyStateTrackerState> = new Store(\n getDefaultKeyStateTrackerState(),\n )\n\n #heldEntries: Map<string, { key: string; code: string }> = new Map()\n #keydownListener: ((event: KeyboardEvent) => void) | null = null\n #keyupListener: ((event: KeyboardEvent) => void) | null = null\n #blurListener: (() => void) | null = null\n\n private constructor() {\n this.#setupListeners()\n }\n\n /**\n * Gets the singleton instance of KeyStateTracker.\n */\n static getInstance(): KeyStateTracker {\n if (!KeyStateTracker.#instance) {\n KeyStateTracker.#instance = new KeyStateTracker()\n }\n return KeyStateTracker.#instance\n }\n\n /**\n * Resets the singleton instance. Useful for testing.\n */\n static resetInstance(): void {\n if (KeyStateTracker.#instance) {\n KeyStateTracker.#instance.destroy()\n KeyStateTracker.#instance = null\n }\n }\n\n /**\n * Sets up the keyboard event listeners.\n */\n #setupListeners(): void {\n if (typeof document === 'undefined') {\n return // SSR safety\n }\n\n this.#keydownListener = (event: KeyboardEvent) => {\n const key = normalizeKeyName(event.key)\n const identity = event.code || `key:${key}`\n if (!this.#heldEntries.has(identity)) {\n this.#heldEntries.set(identity, { key, code: event.code })\n this.#syncState()\n }\n }\n\n this.#keyupListener = (event: KeyboardEvent) => {\n const key = normalizeKeyName(event.key)\n const identity = event.code || `key:${key}`\n this.#heldEntries.delete(identity)\n\n // Code-less keyup events can only be paired by their logical key.\n if (!event.code) {\n for (const [entryIdentity, entry] of this.#heldEntries) {\n if (entry.key === key) this.#heldEntries.delete(entryIdentity)\n }\n }\n\n // When a modifier key is released, clear any non-modifier keys still\n // marked as held. On macOS, the OS intercepts modifier+key combos\n // (e.g. Cmd+S) and swallows the keyup event for the non-modifier key,\n // leaving it permanently stuck in the held set.\n if (MODIFIER_KEYS.has(key)) {\n for (const [entryIdentity, entry] of this.#heldEntries) {\n if (!MODIFIER_KEYS.has(entry.key)) {\n this.#heldEntries.delete(entryIdentity)\n }\n }\n }\n\n this.#syncState()\n }\n\n // Clear all keys when window loses focus (keys might be released while not focused)\n this.#blurListener = () => {\n if (this.#heldEntries.size > 0) {\n this.#heldEntries.clear()\n this.#syncState()\n }\n }\n\n document.addEventListener('keydown', this.#keydownListener, true)\n document.addEventListener('keyup', this.#keyupListener, true)\n window.addEventListener('blur', this.#blurListener)\n }\n\n /**\n * Syncs the internal Set to the Store state.\n */\n #syncState(): void {\n const heldKeys = Array.from(\n new Set(Array.from(this.#heldEntries.values(), (entry) => entry.key)),\n )\n const heldCodes = Object.fromEntries(\n Array.from(this.#heldEntries.values(), (entry) => [\n entry.key,\n entry.code,\n ]),\n )\n this.store.setState(() => ({\n heldKeys,\n heldCodes,\n }))\n }\n\n /**\n * Removes the keyboard event listeners.\n */\n #removeListeners(): void {\n if (typeof document === 'undefined') {\n return\n }\n\n if (this.#keydownListener) {\n document.removeEventListener('keydown', this.#keydownListener, true)\n this.#keydownListener = null\n }\n\n if (this.#keyupListener) {\n document.removeEventListener('keyup', this.#keyupListener, true)\n this.#keyupListener = null\n }\n\n if (this.#blurListener) {\n window.removeEventListener('blur', this.#blurListener)\n this.#blurListener = null\n }\n }\n\n /**\n * Gets an array of currently held key names.\n *\n * @returns Array of key names currently being pressed\n */\n getHeldKeys(): Array<string> {\n return this.store.state.heldKeys\n }\n\n /**\n * Checks if a specific key is currently being held.\n *\n * @param key - The key name to check (case-insensitive)\n * @returns True if the key is currently held\n */\n isKeyHeld(key: string): boolean {\n const normalizedKey = normalizeKeyName(key)\n return Array.from(this.#heldEntries.values()).some(\n (entry) => entry.key === normalizedKey,\n )\n }\n\n /**\n * Checks if any of the given keys are currently held.\n *\n * @param keys - Array of key names to check\n * @returns True if any of the keys are currently held\n */\n isAnyKeyHeld(keys: Array<string>): boolean {\n return keys.some((key) => this.isKeyHeld(key))\n }\n\n /**\n * Checks if all of the given keys are currently held.\n *\n * @param keys - Array of key names to check\n * @returns True if all of the keys are currently held\n */\n areAllKeysHeld(keys: Array<string>): boolean {\n return keys.every((key) => this.isKeyHeld(key))\n }\n\n /**\n * Destroys the tracker and removes all listeners.\n */\n destroy(): void {\n this.#removeListeners()\n this.#heldEntries.clear()\n this.store.setState(() => getDefaultKeyStateTrackerState())\n }\n}\n\n/**\n * Gets the singleton KeyStateTracker instance.\n * Convenience function for accessing the tracker.\n */\nexport function getKeyStateTracker(): KeyStateTracker {\n return KeyStateTracker.getInstance()\n}\n"],"mappings":";;;;;;;AAqBA,SAAS,iCAAuD;AAC9D,QAAO;EACL,UAAU,EAAE;EACZ,WAAW,EAAE;EACd;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqCH,IAAa,kBAAb,MAAa,gBAAgB;CAC3B,QAAOA,WAAoC;CAU3C,+BAA2D,IAAI,KAAK;CACpE,mBAA4D;CAC5D,iBAA0D;CAC1D,gBAAqC;CAErC,AAAQ,cAAc;eATwB,IAAIC,sBAChD,gCAAgC,CACjC;AAQC,QAAKC,gBAAiB;;;;;CAMxB,OAAO,cAA+B;AACpC,MAAI,CAAC,iBAAgBF,SACnB,kBAAgBA,WAAY,IAAI,iBAAiB;AAEnD,SAAO,iBAAgBA;;;;;CAMzB,OAAO,gBAAsB;AAC3B,MAAI,iBAAgBA,UAAW;AAC7B,oBAAgBA,SAAU,SAAS;AACnC,oBAAgBA,WAAY;;;;;;CAOhC,kBAAwB;AACtB,MAAI,OAAO,aAAa,YACtB;AAGF,QAAKG,mBAAoB,UAAyB;GAChD,MAAM,MAAMC,mCAAiB,MAAM,IAAI;GACvC,MAAM,WAAW,MAAM,QAAQ,OAAO;AACtC,OAAI,CAAC,MAAKC,YAAa,IAAI,SAAS,EAAE;AACpC,UAAKA,YAAa,IAAI,UAAU;KAAE;KAAK,MAAM,MAAM;KAAM,CAAC;AAC1D,UAAKC,WAAY;;;AAIrB,QAAKC,iBAAkB,UAAyB;GAC9C,MAAM,MAAMH,mCAAiB,MAAM,IAAI;GACvC,MAAM,WAAW,MAAM,QAAQ,OAAO;AACtC,SAAKC,YAAa,OAAO,SAAS;AAGlC,OAAI,CAAC,MAAM,MACT;SAAK,MAAM,CAAC,eAAe,UAAU,MAAKA,YACxC,KAAI,MAAM,QAAQ,IAAK,OAAKA,YAAa,OAAO,cAAc;;AAQlE,OAAIG,gCAAc,IAAI,IAAI,EACxB;SAAK,MAAM,CAAC,eAAe,UAAU,MAAKH,YACxC,KAAI,CAACG,gCAAc,IAAI,MAAM,IAAI,CAC/B,OAAKH,YAAa,OAAO,cAAc;;AAK7C,SAAKC,WAAY;;AAInB,QAAKG,qBAAsB;AACzB,OAAI,MAAKJ,YAAa,OAAO,GAAG;AAC9B,UAAKA,YAAa,OAAO;AACzB,UAAKC,WAAY;;;AAIrB,WAAS,iBAAiB,WAAW,MAAKH,iBAAkB,KAAK;AACjE,WAAS,iBAAiB,SAAS,MAAKI,eAAgB,KAAK;AAC7D,SAAO,iBAAiB,QAAQ,MAAKE,aAAc;;;;;CAMrD,aAAmB;EACjB,MAAM,WAAW,MAAM,KACrB,IAAI,IAAI,MAAM,KAAK,MAAKJ,YAAa,QAAQ,GAAG,UAAU,MAAM,IAAI,CAAC,CACtE;EACD,MAAM,YAAY,OAAO,YACvB,MAAM,KAAK,MAAKA,YAAa,QAAQ,GAAG,UAAU,CAChD,MAAM,KACN,MAAM,KACP,CAAC,CACH;AACD,OAAK,MAAM,gBAAgB;GACzB;GACA;GACD,EAAE;;;;;CAML,mBAAyB;AACvB,MAAI,OAAO,aAAa,YACtB;AAGF,MAAI,MAAKF,iBAAkB;AACzB,YAAS,oBAAoB,WAAW,MAAKA,iBAAkB,KAAK;AACpE,SAAKA,kBAAmB;;AAG1B,MAAI,MAAKI,eAAgB;AACvB,YAAS,oBAAoB,SAAS,MAAKA,eAAgB,KAAK;AAChE,SAAKA,gBAAiB;;AAGxB,MAAI,MAAKE,cAAe;AACtB,UAAO,oBAAoB,QAAQ,MAAKA,aAAc;AACtD,SAAKA,eAAgB;;;;;;;;CASzB,cAA6B;AAC3B,SAAO,KAAK,MAAM,MAAM;;;;;;;;CAS1B,UAAU,KAAsB;EAC9B,MAAM,gBAAgBL,mCAAiB,IAAI;AAC3C,SAAO,MAAM,KAAK,MAAKC,YAAa,QAAQ,CAAC,CAAC,MAC3C,UAAU,MAAM,QAAQ,cAC1B;;;;;;;;CASH,aAAa,MAA8B;AACzC,SAAO,KAAK,MAAM,QAAQ,KAAK,UAAU,IAAI,CAAC;;;;;;;;CAShD,eAAe,MAA8B;AAC3C,SAAO,KAAK,OAAO,QAAQ,KAAK,UAAU,IAAI,CAAC;;;;;CAMjD,UAAgB;AACd,QAAKK,iBAAkB;AACvB,QAAKL,YAAa,OAAO;AACzB,OAAK,MAAM,eAAe,gCAAgC,CAAC;;;;;;;AAQ/D,SAAgB,qBAAsC;AACpD,QAAO,gBAAgB,aAAa"}
|