@vielzeug/keymap 1.1.3 → 2.1.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 +25 -56
- package/dist/conflicts.cjs +1 -1
- package/dist/conflicts.cjs.map +1 -1
- package/dist/conflicts.d.ts.map +1 -1
- package/dist/conflicts.js +4 -2
- package/dist/conflicts.js.map +1 -1
- package/dist/errors.cjs +1 -1
- package/dist/errors.cjs.map +1 -1
- package/dist/errors.d.ts +0 -1
- package/dist/errors.d.ts.map +1 -1
- package/dist/errors.js +1 -5
- package/dist/errors.js.map +1 -1
- package/dist/format.cjs.map +1 -1
- package/dist/format.js.map +1 -1
- package/dist/index.cjs +1 -1
- package/dist/index.d.ts +3 -5
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -2
- package/dist/keymap.cjs +1 -1
- package/dist/keymap.cjs.map +1 -1
- package/dist/keymap.d.ts +4 -5
- package/dist/keymap.d.ts.map +1 -1
- package/dist/keymap.iife.js +1 -1
- package/dist/keymap.iife.js.map +1 -1
- package/dist/keymap.js +1 -1
- package/dist/keymap.js.map +1 -1
- package/dist/parser.cjs +1 -1
- package/dist/parser.cjs.map +1 -1
- package/dist/parser.d.ts.map +1 -1
- package/dist/parser.js +28 -32
- package/dist/parser.js.map +1 -1
- package/dist/types.d.ts +71 -6
- package/dist/types.d.ts.map +1 -1
- package/package.json +19 -14
- package/dist/layer.cjs +0 -2
- package/dist/layer.cjs.map +0 -1
- package/dist/layer.d.ts +0 -31
- package/dist/layer.d.ts.map +0 -1
- package/dist/layer.js +0 -50
- package/dist/layer.js.map +0 -1
package/README.md
CHANGED
|
@@ -1,21 +1,15 @@
|
|
|
1
1
|
# @vielzeug/keymap
|
|
2
2
|
|
|
3
|
-
Headless keyboard shortcut manager with chord
|
|
3
|
+
Headless keyboard shortcut manager with target-local chord state, event-aware guards, conflict detection, and terminal disposal.
|
|
4
4
|
|
|
5
5
|
## Features
|
|
6
6
|
|
|
7
|
-
-
|
|
8
|
-
-
|
|
9
|
-
-
|
|
10
|
-
-
|
|
11
|
-
-
|
|
12
|
-
-
|
|
13
|
-
- **Dynamic bindings** — `map.bind()` / `map.unbind()` at any time — the most recent `bind()` for a shortcut always wins
|
|
14
|
-
- **`findShortcutConflicts()`** — detect prefix/duplicate conflicts before binding a user-customized shortcut
|
|
15
|
-
- **`formatShortcut()`** — platform-aware display formatter (`⇧⌘P` on Mac, `Ctrl+Shift+P` elsewhere)
|
|
16
|
-
- **`createKeymapLayer()`** — scoped keymap stack with `activate()` / `deactivate()`
|
|
17
|
-
- **Headless** — accepts any `EventTarget`; works without a DOM (SSR, Node tests)
|
|
18
|
-
- **Disposable** — `dispose()` + `[Symbol.dispose]` for `using` declarations
|
|
7
|
+
- `createKeymap()` manages bindings on one or more `EventTarget`s.
|
|
8
|
+
- Chords support sequences such as `"g g"` and `"ctrl+k ctrl+s"`.
|
|
9
|
+
- `when(event)` guards inspect event target and composed path.
|
|
10
|
+
- `findShortcutConflicts()` detects duplicate and unreachable prefix paths.
|
|
11
|
+
- `formatShortcut()` produces Mac symbols or platform labels.
|
|
12
|
+
- `dispose()` releases all listeners and permanently ends manager lifecycle.
|
|
19
13
|
|
|
20
14
|
## Install
|
|
21
15
|
|
|
@@ -23,56 +17,31 @@ Headless keyboard shortcut manager with chord sequences, per-binding context gua
|
|
|
23
17
|
pnpm add @vielzeug/keymap
|
|
24
18
|
```
|
|
25
19
|
|
|
26
|
-
## Quick
|
|
20
|
+
## Quick Start
|
|
27
21
|
|
|
28
|
-
|
|
22
|
+
Create one map for an application scope, then mount and dispose it with that scope.
|
|
23
|
+
|
|
24
|
+
```ts
|
|
29
25
|
import { createKeymap, formatShortcut } from '@vielzeug/keymap';
|
|
30
26
|
|
|
27
|
+
const isEditableTarget = (target: EventTarget | null): boolean =>
|
|
28
|
+
target instanceof HTMLInputElement || target instanceof HTMLTextAreaElement || target instanceof HTMLElement && target.isContentEditable;
|
|
29
|
+
|
|
31
30
|
const map = createKeymap({
|
|
32
|
-
'mod+k mod+s': () => save
|
|
33
|
-
'mod+shift+p': () =>
|
|
34
|
-
'g g':
|
|
35
|
-
|
|
36
|
-
space:
|
|
37
|
-
}
|
|
31
|
+
'mod+k mod+s': () => console.log('save'),
|
|
32
|
+
'mod+shift+p': () => console.log('open palette'),
|
|
33
|
+
'g g': () => window.scrollTo({ top: 0 }),
|
|
34
|
+
escape: { handler: () => console.log('close panel'), when: (event) => !isEditableTarget(event.target) },
|
|
35
|
+
space: { handler: () => console.log('toggle playback'), trigger: 'keyup' },
|
|
36
|
+
});
|
|
38
37
|
|
|
39
38
|
const unmount = map.mount(document);
|
|
39
|
+
console.log(formatShortcut('mod+shift+p', 'meta')); // ⇧⌘P
|
|
40
40
|
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
unbind(); // or: map.unbind('ctrl+z')
|
|
44
|
-
|
|
45
|
-
// Display helper:
|
|
46
|
-
formatShortcut('mod+shift+p', 'meta'); // '⇧⌘P'
|
|
47
|
-
formatShortcut('mod+shift+p', 'ctrl'); // 'Ctrl+Shift+P'
|
|
48
|
-
|
|
49
|
-
// Cleanup:
|
|
50
|
-
unmount(); // remove from this target only
|
|
51
|
-
map.dispose(); // or: using map = createKeymap(…)
|
|
41
|
+
unmount();
|
|
42
|
+
map.dispose();
|
|
52
43
|
```
|
|
53
44
|
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
Stack keymaps for modal UI. Mount the base and the layer independently — each manages its own listeners:
|
|
57
|
-
|
|
58
|
-
```typescript
|
|
59
|
-
import { createKeymap, createKeymapLayer } from '@vielzeug/keymap';
|
|
60
|
-
|
|
61
|
-
const base = createKeymap({ 'ctrl+z': undo });
|
|
62
|
-
const modal = createKeymapLayer(base, {
|
|
63
|
-
esc: { handler: closeModal, when: () => isModalOpen() },
|
|
64
|
-
});
|
|
65
|
-
|
|
66
|
-
const unmountBase = base.mount(document);
|
|
67
|
-
const unmountModal = modal.mount(document);
|
|
68
|
-
|
|
69
|
-
modal.deactivate(); // base handles everything; layer is suspended
|
|
70
|
-
modal.activate(); // layer takes over again
|
|
71
|
-
|
|
72
|
-
modal.parent === base; // true — parent reference is accessible
|
|
73
|
-
|
|
74
|
-
unmountModal();
|
|
75
|
-
unmountBase();
|
|
76
|
-
```
|
|
45
|
+
Use separate maps with mutually exclusive `when(event)` guards for independent UI owners that share shortcuts. `dispose()` is terminal; temporary detachment uses mount callbacks.
|
|
77
46
|
|
|
78
|
-
[Full
|
|
47
|
+
[Full documentation](https://vielzeug.dev/keymap/)
|
package/dist/conflicts.cjs
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
const e=require("./parser.cjs");function t(t,n){return t.length>n.length?!1:e.canonicalizeShortcut(t)===e.canonicalizeShortcut(n.slice(0,t.length))}function n(n,r,i={}){let{modKey:a,trigger:o=`keydown`}=i
|
|
1
|
+
const e=require("./parser.cjs");function t(t,n){return t.length>n.length?!1:e.canonicalizeShortcut(t)===e.canonicalizeShortcut(n.slice(0,t.length))}function n(n,r,i={}){let{modKey:a,trigger:o=`keydown`}=i;if(n.trim()===``)return[];let s=e.parseShortcut(n,a);return r.filter(e=>e.trigger===o&&(t(s,e.shortcut)||t(e.shortcut,s)))}exports.findShortcutConflicts=n;
|
|
2
2
|
//# sourceMappingURL=conflicts.cjs.map
|
package/dist/conflicts.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"conflicts.cjs","names":[],"sources":["../src/conflicts.ts"],"sourcesContent":["import type { ShortcutStep } from './parser';\nimport
|
|
1
|
+
{"version":3,"file":"conflicts.cjs","names":[],"sources":["../src/conflicts.ts"],"sourcesContent":["import type { ShortcutStep } from './parser';\nimport { canonicalizeShortcut, parseShortcut } from './parser';\nimport type { BindingEntry } from './types';\n\nexport interface ConflictOptions {\n modKey?: 'ctrl' | 'meta';\n trigger?: 'keydown' | 'keyup';\n}\n\nfunction isPrefixOf(shorter: readonly ShortcutStep[], longer: readonly ShortcutStep[]): boolean {\n if (shorter.length > longer.length) return false;\n\n return canonicalizeShortcut(shorter) === canonicalizeShortcut(longer.slice(0, shorter.length));\n}\n\n/**\n * Finds registered bindings that would conflict with a proposed shortcut — an exact duplicate, a\n * shorter binding that would shadow it as a chord prefix, or a longer binding it would itself\n * shadow. Only compares against entries sharing the same `trigger` — `'keydown'` and `'keyup'`\n * chords are matched independently and never conflict with each other.\n *\n * @example\n * const entries = map.listBindings();\n * findShortcutConflicts('g g', entries); // → the entry for 'g', if one is bound\n */\nexport function findShortcutConflicts(\n shortcut: string,\n entries: readonly BindingEntry[],\n options: ConflictOptions = {},\n): BindingEntry[] {\n const { modKey, trigger = 'keydown' } = options;\n\n // An empty/whitespace-only shortcut would be a trivial prefix of every entry — never report it\n // as a conflict.\n if (shortcut.trim() === '') return [];\n\n const steps = parseShortcut(shortcut, modKey);\n\n return entries.filter(\n (entry) => entry.trigger === trigger && (isPrefixOf(steps, entry.shortcut) || isPrefixOf(entry.shortcut, steps)),\n );\n}\n"],"mappings":"gCASA,SAAS,EAAW,EAAkC,EAA0C,CAG9F,OAFI,EAAQ,OAAS,EAAO,OAAe,GAEpC,EAAA,qBAAqB,CAAO,IAAM,EAAA,qBAAqB,EAAO,MAAM,EAAG,EAAQ,MAAM,CAAC,CAC/F,CAYA,SAAgB,EACd,EACA,EACA,EAA2B,CAAC,EACZ,CAChB,GAAM,CAAE,SAAQ,UAAU,WAAc,EAIxC,GAAI,EAAS,KAAK,IAAM,GAAI,MAAO,CAAC,EAEpC,IAAM,EAAQ,EAAA,cAAc,EAAU,CAAM,EAE5C,OAAO,EAAQ,OACZ,GAAU,EAAM,UAAY,IAAY,EAAW,EAAO,EAAM,QAAQ,GAAK,EAAW,EAAM,SAAU,CAAK,EAChH,CACF"}
|
package/dist/conflicts.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"conflicts.d.ts","sourceRoot":"","sources":["../src/conflicts.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"conflicts.d.ts","sourceRoot":"","sources":["../src/conflicts.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAE5C,MAAM,WAAW,eAAe;IAC9B,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACzB,OAAO,CAAC,EAAE,SAAS,GAAG,OAAO,CAAC;CAC/B;AAQD;;;;;;;;;GASG;AACH,wBAAgB,qBAAqB,CACnC,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,SAAS,YAAY,EAAE,EAChC,OAAO,GAAE,eAAoB,GAC5B,YAAY,EAAE,CAYhB"}
|
package/dist/conflicts.js
CHANGED
|
@@ -4,8 +4,10 @@ function n(t, n) {
|
|
|
4
4
|
return t.length > n.length ? !1 : e(t) === e(n.slice(0, t.length));
|
|
5
5
|
}
|
|
6
6
|
function r(e, r, i = {}) {
|
|
7
|
-
let { modKey: a, trigger: o = "keydown" } = i
|
|
8
|
-
|
|
7
|
+
let { modKey: a, trigger: o = "keydown" } = i;
|
|
8
|
+
if (e.trim() === "") return [];
|
|
9
|
+
let s = t(e, a);
|
|
10
|
+
return r.filter((e) => e.trigger === o && (n(s, e.shortcut) || n(e.shortcut, s)));
|
|
9
11
|
}
|
|
10
12
|
//#endregion
|
|
11
13
|
export { r as findShortcutConflicts };
|
package/dist/conflicts.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"conflicts.js","names":[],"sources":["../src/conflicts.ts"],"sourcesContent":["import type { ShortcutStep } from './parser';\nimport
|
|
1
|
+
{"version":3,"file":"conflicts.js","names":[],"sources":["../src/conflicts.ts"],"sourcesContent":["import type { ShortcutStep } from './parser';\nimport { canonicalizeShortcut, parseShortcut } from './parser';\nimport type { BindingEntry } from './types';\n\nexport interface ConflictOptions {\n modKey?: 'ctrl' | 'meta';\n trigger?: 'keydown' | 'keyup';\n}\n\nfunction isPrefixOf(shorter: readonly ShortcutStep[], longer: readonly ShortcutStep[]): boolean {\n if (shorter.length > longer.length) return false;\n\n return canonicalizeShortcut(shorter) === canonicalizeShortcut(longer.slice(0, shorter.length));\n}\n\n/**\n * Finds registered bindings that would conflict with a proposed shortcut — an exact duplicate, a\n * shorter binding that would shadow it as a chord prefix, or a longer binding it would itself\n * shadow. Only compares against entries sharing the same `trigger` — `'keydown'` and `'keyup'`\n * chords are matched independently and never conflict with each other.\n *\n * @example\n * const entries = map.listBindings();\n * findShortcutConflicts('g g', entries); // → the entry for 'g', if one is bound\n */\nexport function findShortcutConflicts(\n shortcut: string,\n entries: readonly BindingEntry[],\n options: ConflictOptions = {},\n): BindingEntry[] {\n const { modKey, trigger = 'keydown' } = options;\n\n // An empty/whitespace-only shortcut would be a trivial prefix of every entry — never report it\n // as a conflict.\n if (shortcut.trim() === '') return [];\n\n const steps = parseShortcut(shortcut, modKey);\n\n return entries.filter(\n (entry) => entry.trigger === trigger && (isPrefixOf(steps, entry.shortcut) || isPrefixOf(entry.shortcut, steps)),\n );\n}\n"],"mappings":";;AASA,SAAS,EAAW,GAAkC,GAA0C;CAG9F,OAFI,EAAQ,SAAS,EAAO,SAAe,KAEpC,EAAqB,CAAO,MAAM,EAAqB,EAAO,MAAM,GAAG,EAAQ,MAAM,CAAC;AAC/F;AAYA,SAAgB,EACd,GACA,GACA,IAA2B,CAAC,GACZ;CAChB,IAAM,EAAE,WAAQ,aAAU,cAAc;CAIxC,IAAI,EAAS,KAAK,MAAM,IAAI,OAAO,CAAC;CAEpC,IAAM,IAAQ,EAAc,GAAU,CAAM;CAE5C,OAAO,EAAQ,QACZ,MAAU,EAAM,YAAY,MAAY,EAAW,GAAO,EAAM,QAAQ,KAAK,EAAW,EAAM,UAAU,CAAK,EAChH;AACF"}
|
package/dist/errors.cjs
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
var e=class e extends Error{constructor(e,t){super(e,t),this.name=new.target.name,Object.setPrototypeOf(this,new.target.prototype)}static is(t){return t instanceof e}},t=class extends e{
|
|
1
|
+
var e=class e extends Error{constructor(e,t){super(e,t),this.name=new.target.name,Object.setPrototypeOf(this,new.target.prototype)}static is(t){return t instanceof e}},t=class extends e{};exports.KeymapError=e,exports.KeymapParseError=t;
|
|
2
2
|
//# sourceMappingURL=errors.cjs.map
|
package/dist/errors.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"errors.cjs","names":[],"sources":["../src/errors.ts"],"sourcesContent":["/** Base class for all keymap errors. Use `instanceof KeymapError` to catch any keymap-originated error. */\nexport class KeymapError extends Error {\n constructor(message: string, opts?: ErrorOptions) {\n super(message, opts);\n this.name = new.target.name;\n Object.setPrototypeOf(this, new.target.prototype);\n }\n\n static is(err: unknown): err is KeymapError {\n return err instanceof KeymapError;\n }\n}\n\n/** Thrown when a shortcut string cannot be parsed — ambiguous or invalid key step. */\nexport class KeymapParseError extends KeymapError {
|
|
1
|
+
{"version":3,"file":"errors.cjs","names":[],"sources":["../src/errors.ts"],"sourcesContent":["/** Base class for all keymap errors. Use `instanceof KeymapError` to catch any keymap-originated error. */\nexport class KeymapError extends Error {\n constructor(message: string, opts?: ErrorOptions) {\n super(message, opts);\n this.name = new.target.name;\n Object.setPrototypeOf(this, new.target.prototype);\n }\n\n static is(err: unknown): err is KeymapError {\n return err instanceof KeymapError;\n }\n}\n\n/** Thrown when a shortcut string cannot be parsed — ambiguous or invalid key step. */\nexport class KeymapParseError extends KeymapError {}\n"],"mappings":"AACA,IAAa,EAAb,MAAa,UAAoB,KAAM,CACrC,YAAY,EAAiB,EAAqB,CAChD,MAAM,EAAS,CAAI,EACnB,KAAK,KAAO,WAAW,KACvB,OAAO,eAAe,KAAM,WAAW,SAAS,CAClD,CAEA,OAAO,GAAG,EAAkC,CAC1C,OAAO,aAAe,CACxB,CACF,EAGa,EAAb,cAAsC,CAAY,CAAC"}
|
package/dist/errors.d.ts
CHANGED
|
@@ -5,6 +5,5 @@ export declare class KeymapError extends Error {
|
|
|
5
5
|
}
|
|
6
6
|
/** Thrown when a shortcut string cannot be parsed — ambiguous or invalid key step. */
|
|
7
7
|
export declare class KeymapParseError extends KeymapError {
|
|
8
|
-
constructor(message: string);
|
|
9
8
|
}
|
|
10
9
|
//# sourceMappingURL=errors.d.ts.map
|
package/dist/errors.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,2GAA2G;AAC3G,qBAAa,WAAY,SAAQ,KAAK;gBACxB,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,YAAY;IAMhD,MAAM,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,WAAW;CAG5C;AAED,sFAAsF;AACtF,qBAAa,gBAAiB,SAAQ,WAAW;
|
|
1
|
+
{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,2GAA2G;AAC3G,qBAAa,WAAY,SAAQ,KAAK;gBACxB,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,YAAY;IAMhD,MAAM,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,WAAW;CAG5C;AAED,sFAAsF;AACtF,qBAAa,gBAAiB,SAAQ,WAAW;CAAG"}
|
package/dist/errors.js
CHANGED
package/dist/errors.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"errors.js","names":[],"sources":["../src/errors.ts"],"sourcesContent":["/** Base class for all keymap errors. Use `instanceof KeymapError` to catch any keymap-originated error. */\nexport class KeymapError extends Error {\n constructor(message: string, opts?: ErrorOptions) {\n super(message, opts);\n this.name = new.target.name;\n Object.setPrototypeOf(this, new.target.prototype);\n }\n\n static is(err: unknown): err is KeymapError {\n return err instanceof KeymapError;\n }\n}\n\n/** Thrown when a shortcut string cannot be parsed — ambiguous or invalid key step. */\nexport class KeymapParseError extends KeymapError {
|
|
1
|
+
{"version":3,"file":"errors.js","names":[],"sources":["../src/errors.ts"],"sourcesContent":["/** Base class for all keymap errors. Use `instanceof KeymapError` to catch any keymap-originated error. */\nexport class KeymapError extends Error {\n constructor(message: string, opts?: ErrorOptions) {\n super(message, opts);\n this.name = new.target.name;\n Object.setPrototypeOf(this, new.target.prototype);\n }\n\n static is(err: unknown): err is KeymapError {\n return err instanceof KeymapError;\n }\n}\n\n/** Thrown when a shortcut string cannot be parsed — ambiguous or invalid key step. */\nexport class KeymapParseError extends KeymapError {}\n"],"mappings":";AACA,IAAa,IAAb,MAAa,UAAoB,MAAM;CACrC,YAAY,GAAiB,GAAqB;EAGhD,AAFA,MAAM,GAAS,CAAI,GACnB,KAAK,OAAO,WAAW,MACvB,OAAO,eAAe,MAAM,WAAW,SAAS;CAClD;CAEA,OAAO,GAAG,GAAkC;EAC1C,OAAO,aAAe;CACxB;AACF,GAGa,IAAb,cAAsC,EAAY,CAAC"}
|
package/dist/format.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"format.cjs","names":[],"sources":["../src/format.ts"],"sourcesContent":["import { warn } from './_dev';\nimport { detectModKey, parseShortcut } from './parser';\n\nconst KEY_SYMBOLS: Record<string, string> = {\n ' ': 'Space',\n arrowdown: '↓',\n arrowleft: '←',\n arrowright: '→',\n arrowup: '↑',\n backspace: '⌫',\n delete: '⌦',\n end: 'End',\n enter: '↵',\n escape: 'Esc',\n home: 'Home',\n pagedown: 'PgDn',\n pageup: 'PgUp',\n tab: '⇥',\n};\n\nconst MOD_SYMBOLS_MAC: Record<string, string> = {\n alt: '⌥',\n ctrl: '⌃',\n meta: '⌘',\n shift: '⇧',\n};\n\nconst MOD_LABELS_OTHER: Record<string, string> = {\n alt: 'Alt',\n ctrl: 'Ctrl',\n meta: 'Win',\n shift: 'Shift',\n};\n\nconst MOD_ORDER = ['ctrl', 'alt', 'shift', 'meta'] as const;\n\n/**\n * Formats a shortcut string into a human-readable display string.\n *\n * On Mac (when `modKey` is `'meta'`), uses standard Mac symbols (⌘, ⌥, ⇧, ⌃).\n * On other platforms, uses word labels (Ctrl, Alt, Shift, Win).\n *\n * @example\n * formatShortcut('mod+shift+p', 'meta') // '⇧⌘P' (canonical order: ctrl, alt, shift, meta)\n * formatShortcut('mod+shift+p', 'ctrl') // 'Ctrl+Shift+P'\n * formatShortcut('ctrl+k ctrl+s', 'meta') // '⌃K ⌃S'\n */\nexport function formatShortcut(shortcut: string, modKey: 'ctrl' | 'meta' = detectModKey()): string {\n if (!shortcut.trim()) {\n warn(`formatShortcut() received an empty shortcut string`);\n\n return '';\n }\n\n let steps
|
|
1
|
+
{"version":3,"file":"format.cjs","names":[],"sources":["../src/format.ts"],"sourcesContent":["import { warn } from './_dev';\nimport { detectModKey, parseShortcut } from './parser';\n\nconst KEY_SYMBOLS: Record<string, string> = {\n ' ': 'Space',\n arrowdown: '↓',\n arrowleft: '←',\n arrowright: '→',\n arrowup: '↑',\n backspace: '⌫',\n delete: '⌦',\n end: 'End',\n enter: '↵',\n escape: 'Esc',\n home: 'Home',\n pagedown: 'PgDn',\n pageup: 'PgUp',\n tab: '⇥',\n};\n\nconst MOD_SYMBOLS_MAC: Record<string, string> = {\n alt: '⌥',\n ctrl: '⌃',\n meta: '⌘',\n shift: '⇧',\n};\n\nconst MOD_LABELS_OTHER: Record<string, string> = {\n alt: 'Alt',\n ctrl: 'Ctrl',\n meta: 'Win',\n shift: 'Shift',\n};\n\nconst MOD_ORDER = ['ctrl', 'alt', 'shift', 'meta'] as const;\n\n/**\n * Formats a shortcut string into a human-readable display string.\n *\n * On Mac (when `modKey` is `'meta'`), uses standard Mac symbols (⌘, ⌥, ⇧, ⌃).\n * On other platforms, uses word labels (Ctrl, Alt, Shift, Win).\n *\n * @example\n * formatShortcut('mod+shift+p', 'meta') // '⇧⌘P' (canonical order: ctrl, alt, shift, meta)\n * formatShortcut('mod+shift+p', 'ctrl') // 'Ctrl+Shift+P'\n * formatShortcut('ctrl+k ctrl+s', 'meta') // '⌃K ⌃S'\n */\nexport function formatShortcut(shortcut: string, modKey: 'ctrl' | 'meta' = detectModKey()): string {\n if (!shortcut.trim()) {\n warn(`formatShortcut() received an empty shortcut string`);\n\n return '';\n }\n\n let steps: ReturnType<typeof parseShortcut>;\n\n try {\n steps = parseShortcut(shortcut, modKey);\n } catch {\n warn(`formatShortcut() received an invalid shortcut: \"${shortcut}\"`);\n\n return '';\n }\n\n const isMac = modKey === 'meta';\n\n return steps\n .map((step) => {\n const modParts = MOD_ORDER.filter((m) => step.modifiers.has(m)).map((m) =>\n isMac ? MOD_SYMBOLS_MAC[m] : MOD_LABELS_OTHER[m],\n );\n\n const keyLabel = KEY_SYMBOLS[step.key] ?? step.key.toUpperCase();\n\n return isMac ? `${modParts.join('')}${keyLabel}` : [...modParts, keyLabel].join('+');\n })\n .join(' ');\n}\n"],"mappings":"sDAGA,IAAM,EAAsC,CAC1C,IAAK,QACL,UAAW,IACX,UAAW,IACX,WAAY,IACZ,QAAS,IACT,UAAW,IACX,OAAQ,IACR,IAAK,MACL,MAAO,IACP,OAAQ,MACR,KAAM,OACN,SAAU,OACV,OAAQ,OACR,IAAK,GACP,EAEM,EAA0C,CAC9C,IAAK,IACL,KAAM,IACN,KAAM,IACN,MAAO,GACT,EAEM,EAA2C,CAC/C,IAAK,MACL,KAAM,OACN,KAAM,MACN,MAAO,OACT,EAEM,EAAY,CAAC,OAAQ,MAAO,QAAS,MAAM,EAajD,SAAgB,EAAe,EAAkB,EAA0B,EAAA,aAAa,EAAW,CACjG,GAAI,CAAC,EAAS,KAAK,EAGjB,MAAO,GAGT,IAAI,EAEJ,GAAI,CACF,EAAQ,EAAA,cAAc,EAAU,CAAM,CACxC,MAAQ,CAGN,MAFK,GAAmD,EAAnD,EAEE,EACT,CAEA,IAAM,EAAQ,IAAW,OAEzB,OAAO,EACJ,IAAK,GAAS,CACb,IAAM,EAAW,EAAU,OAAQ,GAAM,EAAK,UAAU,IAAI,CAAC,CAAC,CAAC,CAAC,IAAK,GACnE,EAAQ,EAAgB,GAAK,EAAiB,EAChD,EAEM,EAAW,EAAY,EAAK,MAAQ,EAAK,IAAI,YAAY,EAE/D,OAAO,EAAQ,GAAG,EAAS,KAAK,EAAE,IAAI,IAAa,CAAC,GAAG,EAAU,CAAQ,CAAC,CAAC,KAAK,GAAG,CACrF,CAAC,CAAC,CACD,KAAK,GAAG,CACb"}
|
package/dist/format.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"format.js","names":[],"sources":["../src/format.ts"],"sourcesContent":["import { warn } from './_dev';\nimport { detectModKey, parseShortcut } from './parser';\n\nconst KEY_SYMBOLS: Record<string, string> = {\n ' ': 'Space',\n arrowdown: '↓',\n arrowleft: '←',\n arrowright: '→',\n arrowup: '↑',\n backspace: '⌫',\n delete: '⌦',\n end: 'End',\n enter: '↵',\n escape: 'Esc',\n home: 'Home',\n pagedown: 'PgDn',\n pageup: 'PgUp',\n tab: '⇥',\n};\n\nconst MOD_SYMBOLS_MAC: Record<string, string> = {\n alt: '⌥',\n ctrl: '⌃',\n meta: '⌘',\n shift: '⇧',\n};\n\nconst MOD_LABELS_OTHER: Record<string, string> = {\n alt: 'Alt',\n ctrl: 'Ctrl',\n meta: 'Win',\n shift: 'Shift',\n};\n\nconst MOD_ORDER = ['ctrl', 'alt', 'shift', 'meta'] as const;\n\n/**\n * Formats a shortcut string into a human-readable display string.\n *\n * On Mac (when `modKey` is `'meta'`), uses standard Mac symbols (⌘, ⌥, ⇧, ⌃).\n * On other platforms, uses word labels (Ctrl, Alt, Shift, Win).\n *\n * @example\n * formatShortcut('mod+shift+p', 'meta') // '⇧⌘P' (canonical order: ctrl, alt, shift, meta)\n * formatShortcut('mod+shift+p', 'ctrl') // 'Ctrl+Shift+P'\n * formatShortcut('ctrl+k ctrl+s', 'meta') // '⌃K ⌃S'\n */\nexport function formatShortcut(shortcut: string, modKey: 'ctrl' | 'meta' = detectModKey()): string {\n if (!shortcut.trim()) {\n warn(`formatShortcut() received an empty shortcut string`);\n\n return '';\n }\n\n let steps
|
|
1
|
+
{"version":3,"file":"format.js","names":[],"sources":["../src/format.ts"],"sourcesContent":["import { warn } from './_dev';\nimport { detectModKey, parseShortcut } from './parser';\n\nconst KEY_SYMBOLS: Record<string, string> = {\n ' ': 'Space',\n arrowdown: '↓',\n arrowleft: '←',\n arrowright: '→',\n arrowup: '↑',\n backspace: '⌫',\n delete: '⌦',\n end: 'End',\n enter: '↵',\n escape: 'Esc',\n home: 'Home',\n pagedown: 'PgDn',\n pageup: 'PgUp',\n tab: '⇥',\n};\n\nconst MOD_SYMBOLS_MAC: Record<string, string> = {\n alt: '⌥',\n ctrl: '⌃',\n meta: '⌘',\n shift: '⇧',\n};\n\nconst MOD_LABELS_OTHER: Record<string, string> = {\n alt: 'Alt',\n ctrl: 'Ctrl',\n meta: 'Win',\n shift: 'Shift',\n};\n\nconst MOD_ORDER = ['ctrl', 'alt', 'shift', 'meta'] as const;\n\n/**\n * Formats a shortcut string into a human-readable display string.\n *\n * On Mac (when `modKey` is `'meta'`), uses standard Mac symbols (⌘, ⌥, ⇧, ⌃).\n * On other platforms, uses word labels (Ctrl, Alt, Shift, Win).\n *\n * @example\n * formatShortcut('mod+shift+p', 'meta') // '⇧⌘P' (canonical order: ctrl, alt, shift, meta)\n * formatShortcut('mod+shift+p', 'ctrl') // 'Ctrl+Shift+P'\n * formatShortcut('ctrl+k ctrl+s', 'meta') // '⌃K ⌃S'\n */\nexport function formatShortcut(shortcut: string, modKey: 'ctrl' | 'meta' = detectModKey()): string {\n if (!shortcut.trim()) {\n warn(`formatShortcut() received an empty shortcut string`);\n\n return '';\n }\n\n let steps: ReturnType<typeof parseShortcut>;\n\n try {\n steps = parseShortcut(shortcut, modKey);\n } catch {\n warn(`formatShortcut() received an invalid shortcut: \"${shortcut}\"`);\n\n return '';\n }\n\n const isMac = modKey === 'meta';\n\n return steps\n .map((step) => {\n const modParts = MOD_ORDER.filter((m) => step.modifiers.has(m)).map((m) =>\n isMac ? MOD_SYMBOLS_MAC[m] : MOD_LABELS_OTHER[m],\n );\n\n const keyLabel = KEY_SYMBOLS[step.key] ?? step.key.toUpperCase();\n\n return isMac ? `${modParts.join('')}${keyLabel}` : [...modParts, keyLabel].join('+');\n })\n .join(' ');\n}\n"],"mappings":";;;AAGA,IAAM,IAAsC;CAC1C,KAAK;CACL,WAAW;CACX,WAAW;CACX,YAAY;CACZ,SAAS;CACT,WAAW;CACX,QAAQ;CACR,KAAK;CACL,OAAO;CACP,QAAQ;CACR,MAAM;CACN,UAAU;CACV,QAAQ;CACR,KAAK;AACP,GAEM,IAA0C;CAC9C,KAAK;CACL,MAAM;CACN,MAAM;CACN,OAAO;AACT,GAEM,IAA2C;CAC/C,KAAK;CACL,MAAM;CACN,MAAM;CACN,OAAO;AACT,GAEM,IAAY;CAAC;CAAQ;CAAO;CAAS;AAAM;AAajD,SAAgB,EAAe,GAAkB,IAA0B,EAAa,GAAW;CACjG,IAAI,CAAC,EAAS,KAAK,GAGjB,OAAO;CAGT,IAAI;CAEJ,IAAI;EACF,IAAQ,EAAc,GAAU,CAAM;CACxC,QAAQ;EAGN,OAFK,GAAmD,EAAnD,GAEE;CACT;CAEA,IAAM,IAAQ,MAAW;CAEzB,OAAO,EACJ,KAAK,MAAS;EACb,IAAM,IAAW,EAAU,QAAQ,MAAM,EAAK,UAAU,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,MACnE,IAAQ,EAAgB,KAAK,EAAiB,EAChD,GAEM,IAAW,EAAY,EAAK,QAAQ,EAAK,IAAI,YAAY;EAE/D,OAAO,IAAQ,GAAG,EAAS,KAAK,EAAE,IAAI,MAAa,CAAC,GAAG,GAAU,CAAQ,CAAC,CAAC,KAAK,GAAG;CACrF,CAAC,CAAC,CACD,KAAK,GAAG;AACb"}
|
package/dist/index.cjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});const e=require("./errors.cjs"),t=require("./parser.cjs"),n=require("./conflicts.cjs"),r=require("./format.cjs"),i=require("./keymap.cjs")
|
|
1
|
+
Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});const e=require("./errors.cjs"),t=require("./parser.cjs"),n=require("./conflicts.cjs"),r=require("./format.cjs"),i=require("./keymap.cjs");exports.KeymapError=e.KeymapError,exports.KeymapParseError=e.KeymapParseError,exports.canonicalizeShortcut=t.canonicalizeShortcut,exports.createKeymap=i.createKeymap,exports.detectModKey=t.detectModKey,exports.findShortcutConflicts=n.findShortcutConflicts,exports.formatShortcut=r.formatShortcut,exports.matchStep=t.matchStep,exports.parseShortcut=t.parseShortcut,exports.parseStep=t.parseStep;
|
package/dist/index.d.ts
CHANGED
|
@@ -1,11 +1,9 @@
|
|
|
1
|
+
export type { ConflictOptions } from './conflicts';
|
|
1
2
|
export { findShortcutConflicts } from './conflicts';
|
|
2
3
|
export { KeymapError, KeymapParseError } from './errors';
|
|
3
4
|
export { formatShortcut } from './format';
|
|
4
5
|
export { createKeymap } from './keymap';
|
|
5
|
-
export { createKeymapLayer } from './layer';
|
|
6
|
-
export { canonicalizeShortcut, detectModKey, matchStep, parseShortcut, parseStep } from './parser';
|
|
7
|
-
export type { ConflictOptions } from './conflicts';
|
|
8
|
-
export type { BindingEntry, BindingOptions, BindingValue, Handler, Keymap, KeymapOptions } from './types';
|
|
9
|
-
export type { KeymapLayer } from './layer';
|
|
10
6
|
export type { ModifierKey, Shortcut, ShortcutStep } from './parser';
|
|
7
|
+
export { canonicalizeShortcut, detectModKey, matchStep, parseShortcut, parseStep } from './parser';
|
|
8
|
+
export type { BindingEntry, BindingOptions, BindingValue, ChordStateChange, Handler, Keymap, KeymapOptions, When, } from './types';
|
|
11
9
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,YAAY,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AACzD,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAC1C,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAExC,YAAY,EAAE,WAAW,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACpE,OAAO,EAAE,oBAAoB,EAAE,YAAY,EAAE,SAAS,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AACnG,YAAY,EACV,YAAY,EACZ,cAAc,EACd,YAAY,EACZ,gBAAgB,EAChB,OAAO,EACP,MAAM,EACN,aAAa,EACb,IAAI,GACL,MAAM,SAAS,CAAC"}
|
package/dist/index.js
CHANGED
|
@@ -3,5 +3,4 @@ import { canonicalizeShortcut as n, detectModKey as r, matchStep as i, parseShor
|
|
|
3
3
|
import { findShortcutConflicts as s } from "./conflicts.js";
|
|
4
4
|
import { formatShortcut as c } from "./format.js";
|
|
5
5
|
import { createKeymap as l } from "./keymap.js";
|
|
6
|
-
|
|
7
|
-
export { e as KeymapError, t as KeymapParseError, n as canonicalizeShortcut, l as createKeymap, u as createKeymapLayer, r as detectModKey, s as findShortcutConflicts, c as formatShortcut, i as matchStep, a as parseShortcut, o as parseStep };
|
|
6
|
+
export { e as KeymapError, t as KeymapParseError, n as canonicalizeShortcut, l as createKeymap, r as detectModKey, s as findShortcutConflicts, c as formatShortcut, i as matchStep, a as parseShortcut, o as parseStep };
|
package/dist/keymap.cjs
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});var e=class e extends Error{constructor(e,t){super(e,t),this.name=new.target.name,Object.setPrototypeOf(this,new.target.prototype)}static is(t){return t instanceof e}},t=class extends e{
|
|
1
|
+
Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});var e=class e extends Error{constructor(e,t){super(e,t),this.name=new.target.name,Object.setPrototypeOf(this,new.target.prototype)}static is(t){return t instanceof e}},t=class extends e{};function n(){if(typeof navigator>`u`)return`ctrl`;let e=navigator.userAgentData?.platform??navigator.platform??``;return/mac/i.test(e)?`meta`:`ctrl`}var r={alt:`alt`,cmd:`meta`,command:`meta`,control:`ctrl`,ctrl:`ctrl`,meta:`meta`,opt:`alt`,option:`alt`,shift:`shift`,win:`meta`},i={del:`delete`,down:`arrowdown`,esc:`escape`,left:`arrowleft`,right:`arrowright`,space:` `,spacebar:` `,up:`arrowup`};function a(e,n){let a=e.trim().split(`+`).filter(Boolean).map(e=>e.toLowerCase());if(a.length===0)throw new t(`Invalid shortcut step: "${e}"`);let o={...r,mod:n},s=new Set,c=[];for(let e of a){let t=Object.hasOwn(o,e)?o[e]:void 0;t?s.add(t):c.push(e)}if(c.length===0)throw new t(`Invalid shortcut step: "${e}"`);if(c.length>1)throw new t(`Ambiguous shortcut step: "${e}" — multiple non-modifier keys found`);let l=c[0];return{key:Object.hasOwn(i,l)?i[l]:l,modifiers:s}}function o(e,t=n()){try{return a(e,t)}catch{return null}}function s(e,r=n()){let i=e.trim().split(/\s+/).filter(Boolean);if(i.length===0)throw new t(`Shortcut must contain at least one key step`);return i.map(e=>a(e,r))}function c(e){return e.map(e=>{let t=[...e.modifiers].sort().join(`+`);return t?`${t}+${e.key}`:e.key}).join(` `)}function l(e,t){if(typeof e.key!=`string`||e.key.toLowerCase()!==t.key)return!1;let{modifiers:n}=t;return e.altKey===n.has(`alt`)&&e.ctrlKey===n.has(`ctrl`)&&e.metaKey===n.has(`meta`)&&e.shiftKey===n.has(`shift`)}function u(e,t){return e.length>t.length?!1:c(e)===c(t.slice(0,e.length))}function d(e,t,n={}){let{modKey:r,trigger:i=`keydown`}=n;if(e.trim()===``)return[];let a=s(e,r);return t.filter(e=>e.trigger===i&&(u(a,e.shortcut)||u(e.shortcut,a)))}var f={" ":`Space`,arrowdown:`↓`,arrowleft:`←`,arrowright:`→`,arrowup:`↑`,backspace:`⌫`,delete:`⌦`,end:`End`,enter:`↵`,escape:`Esc`,home:`Home`,pagedown:`PgDn`,pageup:`PgUp`,tab:`⇥`},p={alt:`⌥`,ctrl:`⌃`,meta:`⌘`,shift:`⇧`},m={alt:`Alt`,ctrl:`Ctrl`,meta:`Win`,shift:`Shift`},h=[`ctrl`,`alt`,`shift`,`meta`];function g(e,t=n()){if(!e.trim())return``;let r;try{r=s(e,t)}catch{return`${e}`,``}let i=t===`meta`;return r.map(e=>{let t=h.filter(t=>e.modifiers.has(t)).map(e=>i?p[e]:m[e]),n=f[e.key]??e.key.toUpperCase();return i?`${t.join(``)}${n}`:[...t,n].join(`+`)}).join(` `)}function _(e){return typeof e==`function`?{handler:e,trigger:`keydown`}:{handler:e.handler,trigger:e.trigger??`keydown`,when:e.when}}function v(e,t,n,r,i){let a=0,o=[],s,c=[];function u(e=!1){if(s!==void 0&&clearTimeout(s),e&&a>0&&i?.onChordTimeout)try{i.onChordTimeout(n,r)}catch(e){`${e instanceof Error?e.message:String(e)}`}s=void 0,a=0,o=[],c=[]}function d(f){let p=(a===0?e():o).filter(e=>{let t=e.shortcut[a];return t!==void 0&&l(f,t)});if(p.length===0){let e=a!==0;return u(),e?d(f):void 0}s!==void 0&&clearTimeout(s),s=void 0;let m=p.find(e=>e.shortcut.length===a+1);if(m)return u(),m;let h=p[0].shortcut[a];if(c=p[0].shortcut.slice(0,a+1),a===0&&i?.onChordStart)try{i.onChordStart(n,h,r)}catch(e){`${e instanceof Error?e.message:String(e)}`}else if(a>0&&i?.onChordProgress)try{i.onChordProgress(n,c,r)}catch(e){`${e instanceof Error?e.message:String(e)}`}o=p,a+=1,s=setTimeout(()=>u(!0),t)}return{advance:d,reset:()=>u()}}function y(t={},r={}){let{chordTimeout:i=1e3,modKey:a=n(),preventDefault:o=!0,stopPropagation:l=!1,when:u,onChordState:d}=r,f=Number.isFinite(i)&&i>0?i:1e3;f!==i&&`${i}`;let p=new Map,m=new Map,h=new AbortController,g=[],y=[],b=!1;function x(){if(b)throw new e(`Keymap is disposed`)}function S(){g=[],y=[];for(let e of p.values())e.trigger===`keydown`?g.push(e):y.push(e)}function C(e){return c(s(e,a))}function w(e,t){let n=s(e,a),r=c(n);return p.set(r,{shortcut:n,..._(t)}),S(),r}function T(e){let t=p.delete(e);return t&&S(),t}function E(e){if(d)try{d(e)}catch(e){`${e instanceof Error?e.message:String(e)}`}}function D(e,t){return n=>{let r=(typeof n.composedPath==`function`?n.composedPath():[]).find(e=>m.has(e));if(r&&r!==e)return;let i=n;if(b)return;let a=t.advance(i);u&&!u(i)||!a||a.when&&!a.when(i)||(o&&i.preventDefault(),l&&i.stopPropagation(),a.handler(i))}}for(let[e,n]of Object.entries(t))w(e,n);return{bind(e,t){x();let n=w(e,t);return()=>{b||T(n)}},get disposalSignal(){return h.signal},dispose(){if(!b){b=!0,h.abort();for(let[e,t]of m)e.removeEventListener(`keydown`,t.onKeydown),e.removeEventListener(`keyup`,t.onKeyup),t.keydown.reset(),t.keyup.reset();m.clear(),p.clear(),g=[],y=[]}},get disposed(){return b},listBindings(){return[...p.values()].map(e=>({shortcut:e.shortcut.map(e=>({key:e.key,modifiers:new Set(e.modifiers)})),trigger:e.trigger}))},mount(e){x();let t=m.get(e);if(!t){let n=v(()=>g,f,e,`keydown`,{onChordProgress:(e,t,n)=>E({steps:t,target:e,trigger:n,type:`progressed`}),onChordStart:(e,t,n)=>E({step:t,target:e,trigger:n,type:`started`}),onChordTimeout:(e,t)=>E({target:e,trigger:t,type:`timeout`})}),r=v(()=>y,f,e,`keyup`,{onChordProgress:(e,t,n)=>E({steps:t,target:e,trigger:n,type:`progressed`}),onChordStart:(e,t,n)=>E({step:t,target:e,trigger:n,type:`started`}),onChordTimeout:(e,t)=>E({target:e,trigger:t,type:`timeout`})}),i=D(e,n),a=D(e,r);t={keydown:n,keyup:r,onKeydown:i,onKeyup:a,refs:0},m.set(e,t),e.addEventListener(`keydown`,i),e.addEventListener(`keyup`,a)}t.refs+=1;let n=!1;return()=>{n||(n=!0,--t.refs,!(t?.refs>0)&&(e.removeEventListener(`keydown`,t?.onKeydown),e.removeEventListener(`keyup`,t?.onKeyup),t?.keydown.reset(),t?.keyup.reset(),m.delete(e)))}},[Symbol.dispose](){this.dispose()},unbind(e){x(),T(C(e))||`${e}`}}}exports.KeymapError=e,exports.KeymapParseError=t,exports.canonicalizeShortcut=c,exports.createKeymap=y,exports.detectModKey=n,exports.findShortcutConflicts=d,exports.formatShortcut=g,exports.matchStep=l,exports.parseShortcut=s,exports.parseStep=o;
|
|
2
2
|
//# sourceMappingURL=keymap.cjs.map
|
package/dist/keymap.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"keymap.cjs","names":[],"sources":["../src/errors.ts","../src/parser.ts","../src/conflicts.ts","../src/_dev.ts","../src/format.ts","../src/keymap.ts","../src/layer.ts"],"sourcesContent":["/** Base class for all keymap errors. Use `instanceof KeymapError` to catch any keymap-originated error. */\nexport class KeymapError extends Error {\n constructor(message: string, opts?: ErrorOptions) {\n super(message, opts);\n this.name = new.target.name;\n Object.setPrototypeOf(this, new.target.prototype);\n }\n\n static is(err: unknown): err is KeymapError {\n return err instanceof KeymapError;\n }\n}\n\n/** Thrown when a shortcut string cannot be parsed — ambiguous or invalid key step. */\nexport class KeymapParseError extends KeymapError {\n constructor(message: string) {\n super(message);\n }\n}\n","import { KeymapParseError } from './errors';\n\nexport type ModifierKey = 'alt' | 'ctrl' | 'meta' | 'shift';\n\nexport type ShortcutStep = {\n key: string;\n modifiers: Set<ModifierKey>;\n};\n\nexport type Shortcut = ShortcutStep[];\n\nexport function detectModKey(): 'ctrl' | 'meta' {\n if (typeof navigator === 'undefined') return 'ctrl';\n\n const platform =\n (navigator as Navigator & { userAgentData?: { platform?: string } }).userAgentData?.platform ??\n navigator.platform ??\n '';\n\n return /mac/i.test(platform) ? 'meta' : 'ctrl';\n}\n\nconst MODIFIER_ALIASES_BASE: Record<string, ModifierKey> = {\n alt: 'alt',\n cmd: 'meta',\n command: 'meta',\n control: 'ctrl',\n ctrl: 'ctrl',\n meta: 'meta',\n opt: 'alt',\n option: 'alt',\n shift: 'shift',\n win: 'meta',\n};\n\nconst SPECIAL_KEY_ALIASES: Record<string, string> = {\n del: 'delete',\n down: 'arrowdown',\n esc: 'escape',\n left: 'arrowleft',\n right: 'arrowright',\n space: ' ',\n spacebar: ' ',\n up: 'arrowup',\n};\n\nfunction buildModifierAliases(modKey: 'ctrl' | 'meta'): Record<string, ModifierKey> {\n return { ...MODIFIER_ALIASES_BASE, mod: modKey };\n}\n\nfunction normalizeModifier(token: string, aliases: Record<string, ModifierKey>): ModifierKey | null {\n const lower = token.toLowerCase();\n\n return Object.hasOwn(aliases, lower) ? aliases[lower]! : null;\n}\n\nfunction normalizeKey(raw: string): string {\n return Object.hasOwn(SPECIAL_KEY_ALIASES, raw) ? SPECIAL_KEY_ALIASES[raw]! : raw;\n}\n\nexport function parseStep(raw: string, modKey: 'ctrl' | 'meta' = detectModKey()): ShortcutStep | null {\n const parts = raw\n .trim()\n .split('+')\n .filter(Boolean)\n .map((p) => p.toLowerCase());\n\n if (parts.length === 0) return null;\n\n const aliases = buildModifierAliases(modKey);\n const modifiers = new Set<ModifierKey>();\n const keyParts: string[] = [];\n\n for (const part of parts) {\n const mod = normalizeModifier(part, aliases);\n\n if (mod) {\n modifiers.add(mod);\n } else {\n keyParts.push(part);\n }\n }\n\n if (keyParts.length === 0) return null;\n\n if (keyParts.length > 1) {\n throw new KeymapParseError(`Ambiguous shortcut step: \"${raw}\" — multiple non-modifier keys found`);\n }\n\n const key = normalizeKey(keyParts[0]);\n\n return { key, modifiers };\n}\n\nexport function parseShortcut(raw: string, modKey: 'ctrl' | 'meta' = detectModKey()): Shortcut {\n return raw\n .trim()\n .split(/\\s+/)\n .filter(Boolean)\n .map((step) => {\n const result = parseStep(step, modKey);\n\n if (result === null) {\n throw new KeymapParseError(`Invalid shortcut step: \"${step}\" in \"${raw}\"`);\n }\n\n return result;\n });\n}\n\nexport function canonicalizeShortcut(steps: readonly ShortcutStep[]): string {\n return steps\n .map((s) => {\n const mods = [...s.modifiers].sort().join('+');\n\n return mods ? `${mods}+${s.key}` : s.key;\n })\n .join(' ');\n}\n\nexport function matchStep(event: KeyboardEvent, step: ShortcutStep): boolean {\n // Headless usage (SSR, non-DOM `EventTarget`s, hand-built test events) means `event` isn't\n // guaranteed to be a real `KeyboardEvent` at runtime even though the type says so — treat a\n // missing/non-string `key` as \"doesn't match\" rather than throwing inside the event listener.\n if (typeof event.key !== 'string') return false;\n\n if (event.key.toLowerCase() !== step.key) return false;\n\n const { modifiers } = step;\n\n if (event.altKey !== modifiers.has('alt')) return false;\n\n if (event.ctrlKey !== modifiers.has('ctrl')) return false;\n\n if (event.metaKey !== modifiers.has('meta')) return false;\n\n if (event.shiftKey !== modifiers.has('shift')) return false;\n\n return true;\n}\n","import type { ShortcutStep } from './parser';\nimport type { BindingEntry } from './types';\n\nimport { canonicalizeShortcut, parseShortcut } from './parser';\n\nexport interface ConflictOptions {\n modKey?: 'ctrl' | 'meta';\n trigger?: 'keydown' | 'keyup';\n}\n\nfunction isPrefixOf(shorter: readonly ShortcutStep[], longer: readonly ShortcutStep[]): boolean {\n if (shorter.length > longer.length) return false;\n\n return canonicalizeShortcut(shorter) === canonicalizeShortcut(longer.slice(0, shorter.length));\n}\n\n/**\n * Finds registered bindings that would conflict with a proposed shortcut — an exact duplicate, a\n * shorter binding that would shadow it as a chord prefix, or a longer binding it would itself\n * shadow. Only compares against entries sharing the same `trigger` — `'keydown'` and `'keyup'`\n * chords are matched independently and never conflict with each other.\n *\n * @example\n * const entries = map.listBindings();\n * findShortcutConflicts('g g', entries); // → the entry for 'g', if one is bound\n */\nexport function findShortcutConflicts(\n shortcut: string,\n entries: readonly BindingEntry[],\n options: ConflictOptions = {},\n): BindingEntry[] {\n const { modKey, trigger = 'keydown' } = options;\n const steps = parseShortcut(shortcut, modKey);\n\n // An empty/whitespace-only shortcut parses to zero steps, which would otherwise be treated as\n // a trivial prefix of every entry — never report that as a conflict.\n if (steps.length === 0) return [];\n\n return entries.filter(\n (entry) => entry.trigger === trigger && (isPrefixOf(steps, entry.shortcut) || isPrefixOf(entry.shortcut, steps)),\n );\n}\n","const isDev = !(globalThis as { __KEYMAP_PROD__?: boolean }).__KEYMAP_PROD__;\n\n/** @internal */\nexport function warn(msg: string): void {\n if (isDev) console.warn(`[@vielzeug/keymap] ${msg}`);\n}\n\n/** @internal — Run fn only in dev builds. Use when dev-only logic goes beyond a single warn() / error() call. */\nexport function devOnly(fn: () => void): void {\n if (isDev) fn();\n}\n","import { warn } from './_dev';\nimport { detectModKey, parseShortcut } from './parser';\n\nconst KEY_SYMBOLS: Record<string, string> = {\n ' ': 'Space',\n arrowdown: '↓',\n arrowleft: '←',\n arrowright: '→',\n arrowup: '↑',\n backspace: '⌫',\n delete: '⌦',\n end: 'End',\n enter: '↵',\n escape: 'Esc',\n home: 'Home',\n pagedown: 'PgDn',\n pageup: 'PgUp',\n tab: '⇥',\n};\n\nconst MOD_SYMBOLS_MAC: Record<string, string> = {\n alt: '⌥',\n ctrl: '⌃',\n meta: '⌘',\n shift: '⇧',\n};\n\nconst MOD_LABELS_OTHER: Record<string, string> = {\n alt: 'Alt',\n ctrl: 'Ctrl',\n meta: 'Win',\n shift: 'Shift',\n};\n\nconst MOD_ORDER = ['ctrl', 'alt', 'shift', 'meta'] as const;\n\n/**\n * Formats a shortcut string into a human-readable display string.\n *\n * On Mac (when `modKey` is `'meta'`), uses standard Mac symbols (⌘, ⌥, ⇧, ⌃).\n * On other platforms, uses word labels (Ctrl, Alt, Shift, Win).\n *\n * @example\n * formatShortcut('mod+shift+p', 'meta') // '⇧⌘P' (canonical order: ctrl, alt, shift, meta)\n * formatShortcut('mod+shift+p', 'ctrl') // 'Ctrl+Shift+P'\n * formatShortcut('ctrl+k ctrl+s', 'meta') // '⌃K ⌃S'\n */\nexport function formatShortcut(shortcut: string, modKey: 'ctrl' | 'meta' = detectModKey()): string {\n if (!shortcut.trim()) {\n warn(`formatShortcut() received an empty shortcut string`);\n\n return '';\n }\n\n let steps;\n\n try {\n steps = parseShortcut(shortcut, modKey);\n } catch {\n warn(`formatShortcut() received an invalid shortcut: \"${shortcut}\"`);\n\n return '';\n }\n\n const isMac = modKey === 'meta';\n\n return steps\n .map((step) => {\n const modParts = MOD_ORDER.filter((m) => step.modifiers.has(m)).map((m) =>\n isMac ? MOD_SYMBOLS_MAC[m] : MOD_LABELS_OTHER[m],\n );\n\n const keyLabel = KEY_SYMBOLS[step.key] ?? step.key.toUpperCase();\n\n return isMac ? `${modParts.join('')}${keyLabel}` : [...modParts, keyLabel].join('+');\n })\n .join(' ');\n}\n","import type { Shortcut } from './parser';\nimport type { BindingEntry, BindingOptions, BindingValue, Handler, Keymap, KeymapOptions } from './types';\n\nimport { warn } from './_dev';\nimport { canonicalizeShortcut, detectModKey, matchStep, parseShortcut } from './parser';\n\ntype ParsedBinding = {\n handler: Handler;\n priority: number;\n shortcut: Shortcut;\n trigger: 'keydown' | 'keyup';\n when?: () => boolean;\n};\n\nfunction resolveBinding(value: BindingValue): Omit<ParsedBinding, 'shortcut'> {\n if (typeof value === 'function') {\n return { handler: value, priority: 0, trigger: 'keydown' };\n }\n\n const priority = value.priority ?? 0;\n\n if (!Number.isFinite(priority)) {\n warn(`binding priority must be a finite number; received ${priority}. Using 0.`);\n }\n\n return {\n handler: value.handler,\n priority: Number.isFinite(priority) ? priority : 0,\n trigger: value.trigger ?? 'keydown',\n when: value.when,\n };\n}\n\nfunction createChordTracker(getBindings: () => ParsedBinding[], chordTimeout: number) {\n let pendingIndex = 0;\n let candidates: ParsedBinding[] = [];\n let timer: ReturnType<typeof setTimeout> | null = null;\n\n function clearTimer(): void {\n if (timer !== null) {\n clearTimeout(timer);\n timer = null;\n }\n }\n\n function reset(): void {\n clearTimer();\n pendingIndex = 0;\n candidates = [];\n }\n\n function advance(event: KeyboardEvent): ParsedBinding | null {\n // At the root of a chord, re-scan every binding. Mid-chord, narrow only within bindings that\n // already matched every prior step — never re-admit a binding whose earlier step didn't match.\n const pool = pendingIndex === 0 ? getBindings() : candidates;\n const matched: ParsedBinding[] = [];\n\n for (const binding of pool) {\n const step = binding.shortcut[pendingIndex];\n\n if (step && matchStep(event, step)) {\n matched.push(binding);\n }\n }\n\n if (matched.length === 0) {\n const wasPartial = pendingIndex !== 0;\n\n reset();\n\n if (wasPartial) {\n return advance(event);\n }\n\n return null;\n }\n\n clearTimer();\n\n // At most one binding can complete here — the bindings map is keyed by canonical shortcut,\n // so two live bindings can never share an identical step sequence. `priority` therefore never\n // has a real tie to resolve; the shortest completing match always fires immediately.\n const completed = matched.find((b) => b.shortcut.length === pendingIndex + 1);\n\n if (completed) {\n reset();\n\n return completed;\n }\n\n candidates = matched;\n pendingIndex++;\n timer = setTimeout(reset, chordTimeout);\n\n return null;\n }\n\n return { advance, reset };\n}\n\n/**\n * Creates a headless keyboard shortcut manager.\n *\n * Pass a bindings map of shortcut strings to handlers or `BindingOptions`, then call\n * `.mount(target)` to attach to any `EventTarget`. Supports chord sequences\n * (e.g. `\"ctrl+k ctrl+s\"`), per-binding `when` guards, `trigger` (keydown/keyup),\n * `priority`, and dynamic `bind`/`unbind`.\n *\n * @example\n * const map = createKeymap({\n * 'mod+k mod+s': () => save(),\n * 'mod+shift+p': () => openPalette(),\n * 'g g': () => goToTop(),\n * esc: { handler: closePanel, when: () => isPanelOpen() },\n * space: { handler: togglePlay, trigger: 'keyup' },\n * }, { modKey: 'ctrl' });\n * const unmount = map.mount(document);\n */\nexport function createKeymap(initialBindings: Record<string, BindingValue> = {}, options: KeymapOptions = {}): Keymap {\n const {\n chordTimeout: rawChordTimeout = 1000,\n modKey = detectModKey(),\n preventDefault = true,\n stopPropagation = false,\n when: globalWhen,\n } = options;\n\n const chordTimeout = Number.isFinite(rawChordTimeout) && rawChordTimeout > 0 ? rawChordTimeout : 1000;\n\n if (chordTimeout !== rawChordTimeout) {\n warn(`chordTimeout must be a positive finite number; received ${rawChordTimeout}. Using default of 1000ms.`);\n }\n\n const bindings = new Map<string, ParsedBinding>();\n let bindingsDown: ParsedBinding[] = [];\n let bindingsUp: ParsedBinding[] = [];\n\n function rebuildTriggerCaches(): void {\n bindingsDown = [];\n bindingsUp = [];\n\n for (const b of bindings.values()) {\n if (b.trigger === 'keydown') bindingsDown.push(b);\n else bindingsUp.push(b);\n }\n }\n\n function addBinding(shortcutStr: string, value: BindingValue): string {\n const shortcut = parseShortcut(shortcutStr, modKey);\n const key = canonicalizeShortcut(shortcut);\n\n bindings.set(key, { shortcut, ...resolveBinding(value) });\n rebuildTriggerCaches();\n\n return key;\n }\n\n function removeByKey(key: string): boolean {\n const existed = bindings.delete(key);\n\n if (existed) rebuildTriggerCaches();\n\n return existed;\n }\n\n function removeBinding(shortcutStr: string): boolean {\n const shortcut = parseShortcut(shortcutStr, modKey);\n const key = canonicalizeShortcut(shortcut);\n\n return removeByKey(key);\n }\n\n for (const [shortcutStr, value] of Object.entries(initialBindings)) {\n const shortcut = parseShortcut(shortcutStr, modKey);\n const key = canonicalizeShortcut(shortcut);\n\n bindings.set(key, { shortcut, ...resolveBinding(value) });\n }\n\n rebuildTriggerCaches();\n\n const chordDown = createChordTracker(() => bindingsDown, chordTimeout);\n const chordUp = createChordTracker(() => bindingsUp, chordTimeout);\n const unmounts = new Set<() => void>();\n const mountCounts = new Map<EventTarget, number>();\n\n function makeHandler(chord: ReturnType<typeof createChordTracker>) {\n return function handleEvent(event: KeyboardEvent): void {\n if (globalWhen && !globalWhen()) return;\n\n const binding = chord.advance(event);\n\n if (!binding) return;\n\n if (binding.when && !binding.when()) return;\n\n if (preventDefault) event.preventDefault();\n\n if (stopPropagation) event.stopPropagation();\n\n binding.handler(event);\n };\n }\n\n const handleKeydown = makeHandler(chordDown);\n const handleKeyup = makeHandler(chordUp);\n const ac = new AbortController();\n let isDisposed = false;\n\n return {\n bind(shortcutStr: string, value: BindingValue): () => void {\n const key = addBinding(shortcutStr, value);\n\n return () => {\n removeByKey(key);\n };\n },\n\n get disposalSignal(): AbortSignal {\n return ac.signal;\n },\n\n dispose(): void {\n if (isDisposed) return;\n\n isDisposed = true;\n ac.abort();\n for (const unmount of unmounts) unmount();\n unmounts.clear();\n chordDown.reset();\n chordUp.reset();\n },\n\n get disposed(): boolean {\n return isDisposed;\n },\n\n listBindings(): readonly BindingEntry[] {\n return [...bindings.values()].map((b) => ({\n priority: b.priority,\n shortcut: b.shortcut.map((s) => ({ key: s.key, modifiers: new Set(s.modifiers) })),\n trigger: b.trigger,\n }));\n },\n\n mount(target: EventTarget): () => void {\n const priorCount = mountCounts.get(target) ?? 0;\n\n if (priorCount > 0) {\n warn('mount() called for a target that is already mounted — this registers a duplicate listener');\n }\n\n mountCounts.set(target, priorCount + 1);\n\n target.addEventListener('keydown', handleKeydown as EventListener);\n target.addEventListener('keyup', handleKeyup as EventListener);\n\n const unmount = (): void => {\n target.removeEventListener('keydown', handleKeydown as EventListener);\n target.removeEventListener('keyup', handleKeyup as EventListener);\n unmounts.delete(unmount);\n\n const remaining = (mountCounts.get(target) ?? 1) - 1;\n\n if (remaining <= 0) mountCounts.delete(target);\n else mountCounts.set(target, remaining);\n };\n\n unmounts.add(unmount);\n\n return unmount;\n },\n\n [Symbol.dispose](): void {\n this.dispose();\n },\n\n unbind(shortcutStr: string): void {\n const existed = removeBinding(shortcutStr);\n\n if (!existed) {\n warn(`unbind() called for unknown shortcut: \"${shortcutStr}\"`);\n }\n },\n };\n}\n\nexport type { BindingOptions };\n","import type { BindingValue, Keymap, KeymapOptions } from './types';\n\nimport { createKeymap } from './keymap';\n\n/**\n * Creates a scoped keymap layer that sits on top of a parent keymap.\n *\n * The **caller** is responsible for mounting and disposing the parent independently.\n * `layer.mount(target)` only attaches the layer's own shortcuts — it does not touch\n * the parent. `layer.dispose()` only tears down the layer — it does not dispose the parent.\n *\n * While the layer is active, matching shortcuts are handled by the layer. Call\n * `layer.deactivate()` to suspend the layer and `layer.activate()` to re-enable it.\n *\n * @example\n * const base = createKeymap({ 'ctrl+z': undo });\n * const modal = createKeymapLayer(base, {\n * esc: { handler: closeModal, when: () => isModalOpen() },\n * });\n * // Mount both independently — the layer does NOT auto-mount the parent.\n * const unmountBase = base.mount(document);\n * const unmountModal = modal.mount(document);\n *\n * modal.deactivate(); // base handles everything; layer is suspended\n * modal.activate(); // layer is active again\n */\nexport interface KeymapLayer extends Keymap {\n activate(): void;\n deactivate(): void;\n readonly active: boolean;\n readonly parent: Keymap;\n}\n\nexport function createKeymapLayer(\n parent: Keymap,\n initialBindings: Record<string, BindingValue> = {},\n options: KeymapOptions = {},\n): KeymapLayer {\n let isActive = true;\n\n const layer = createKeymap(initialBindings, {\n ...options,\n when: () => isActive && (options.when?.() ?? true),\n });\n\n return {\n activate(): void {\n isActive = true;\n },\n\n get active() {\n return isActive;\n },\n\n bind(shortcut: string, value: BindingValue): () => void {\n return layer.bind(shortcut, value);\n },\n\n deactivate(): void {\n isActive = false;\n },\n\n get disposalSignal(): AbortSignal {\n return layer.disposalSignal;\n },\n\n dispose(): void {\n layer.dispose();\n },\n\n get disposed(): boolean {\n return layer.disposed;\n },\n\n listBindings() {\n return layer.listBindings();\n },\n\n mount(target: EventTarget): () => void {\n return layer.mount(target);\n },\n\n get parent() {\n return parent;\n },\n\n [Symbol.dispose](): void {\n this.dispose();\n },\n\n unbind(shortcut: string): void {\n layer.unbind(shortcut);\n },\n };\n}\n"],"mappings":"mEACA,IAAa,EAAb,MAAa,UAAoB,KAAM,CACrC,YAAY,EAAiB,EAAqB,CAChD,MAAM,EAAS,CAAI,EACnB,KAAK,KAAO,WAAW,KACvB,OAAO,eAAe,KAAM,WAAW,SAAS,CAClD,CAEA,OAAO,GAAG,EAAkC,CAC1C,OAAO,aAAe,CACxB,CACF,EAGa,EAAb,cAAsC,CAAY,CAChD,YAAY,EAAiB,CAC3B,MAAM,CAAO,CACf,CACF,ECPA,SAAgB,GAAgC,CAC9C,GAAI,OAAO,UAAc,IAAa,MAAO,OAE7C,IAAM,EACH,UAAoE,eAAe,UACpF,UAAU,UACV,GAEF,MAAO,OAAO,KAAK,CAAQ,EAAI,OAAS,MAC1C,CAEA,IAAM,EAAqD,CACzD,IAAK,MACL,IAAK,OACL,QAAS,OACT,QAAS,OACT,KAAM,OACN,KAAM,OACN,IAAK,MACL,OAAQ,MACR,MAAO,QACP,IAAK,MACP,EAEM,EAA8C,CAClD,IAAK,SACL,KAAM,YACN,IAAK,SACL,KAAM,YACN,MAAO,aACP,MAAO,IACP,SAAU,IACV,GAAI,SACN,EAEA,SAAS,EAAqB,EAAsD,CAClF,MAAO,CAAE,GAAG,EAAuB,IAAK,CAAO,CACjD,CAEA,SAAS,EAAkB,EAAe,EAA0D,CAClG,IAAM,EAAQ,EAAM,YAAY,EAEhC,OAAO,OAAO,OAAO,EAAS,CAAK,EAAI,EAAQ,GAAU,IAC3D,CAEA,SAAS,EAAa,EAAqB,CACzC,OAAO,OAAO,OAAO,EAAqB,CAAG,EAAI,EAAoB,GAAQ,CAC/E,CAEA,SAAgB,EAAU,EAAa,EAA0B,EAAa,EAAwB,CACpG,IAAM,EAAQ,EACX,KAAK,CAAC,CACN,MAAM,GAAG,CAAC,CACV,OAAO,OAAO,CAAC,CACf,IAAK,GAAM,EAAE,YAAY,CAAC,EAE7B,GAAI,EAAM,SAAW,EAAG,OAAO,KAE/B,IAAM,EAAU,EAAqB,CAAM,EACrC,EAAY,IAAI,IAChB,EAAqB,CAAC,EAE5B,IAAK,IAAM,KAAQ,EAAO,CACxB,IAAM,EAAM,EAAkB,EAAM,CAAO,EAEvC,EACF,EAAU,IAAI,CAAG,EAEjB,EAAS,KAAK,CAAI,CAEtB,CAEA,GAAI,EAAS,SAAW,EAAG,OAAO,KAElC,GAAI,EAAS,OAAS,EACpB,MAAM,IAAI,EAAiB,6BAA6B,EAAI,qCAAqC,EAKnG,MAAO,CAAE,IAFG,EAAa,EAAS,EAEzB,EAAK,WAAU,CAC1B,CAEA,SAAgB,EAAc,EAAa,EAA0B,EAAa,EAAa,CAC7F,OAAO,EACJ,KAAK,CAAC,CACN,MAAM,KAAK,CAAC,CACZ,OAAO,OAAO,CAAC,CACf,IAAK,GAAS,CACb,IAAM,EAAS,EAAU,EAAM,CAAM,EAErC,GAAI,IAAW,KACb,MAAM,IAAI,EAAiB,2BAA2B,EAAK,QAAQ,EAAI,EAAE,EAG3E,OAAO,CACT,CAAC,CACL,CAEA,SAAgB,EAAqB,EAAwC,CAC3E,OAAO,EACJ,IAAK,GAAM,CACV,IAAM,EAAO,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,GAAG,EAE7C,OAAO,EAAO,GAAG,EAAK,GAAG,EAAE,MAAQ,EAAE,GACvC,CAAC,CAAC,CACD,KAAK,GAAG,CACb,CAEA,SAAgB,EAAU,EAAsB,EAA6B,CAM3E,GAFI,OAAO,EAAM,KAAQ,UAErB,EAAM,IAAI,YAAY,IAAM,EAAK,IAAK,MAAO,GAEjD,GAAM,CAAE,aAAc,EAUtB,OARI,EAAM,SAAW,EAAU,IAAI,KAAK,GAEpC,EAAM,UAAY,EAAU,IAAI,MAAM,GAEtC,EAAM,UAAY,EAAU,IAAI,MAAM,GAEtC,EAAM,WAAa,EAAU,IAAI,OAAO,CAG9C,CCjIA,SAAS,EAAW,EAAkC,EAA0C,CAG9F,OAFI,EAAQ,OAAS,EAAO,OAAe,GAEpC,EAAqB,CAAO,IAAM,EAAqB,EAAO,MAAM,EAAG,EAAQ,MAAM,CAAC,CAC/F,CAYA,SAAgB,EACd,EACA,EACA,EAA2B,CAAC,EACZ,CAChB,GAAM,CAAE,SAAQ,UAAU,WAAc,EAClC,EAAQ,EAAc,EAAU,CAAM,EAM5C,OAFI,EAAM,SAAW,EAAU,CAAC,EAEzB,EAAQ,OACZ,GAAU,EAAM,UAAY,IAAY,EAAW,EAAO,EAAM,QAAQ,GAAK,EAAW,EAAM,SAAU,CAAK,EAChH,CACF,CEtCA,IAAM,EAAsC,CAC1C,IAAK,QACL,UAAW,IACX,UAAW,IACX,WAAY,IACZ,QAAS,IACT,UAAW,IACX,OAAQ,IACR,IAAK,MACL,MAAO,IACP,OAAQ,MACR,KAAM,OACN,SAAU,OACV,OAAQ,OACR,IAAK,GACP,EAEM,EAA0C,CAC9C,IAAK,IACL,KAAM,IACN,KAAM,IACN,MAAO,GACT,EAEM,EAA2C,CAC/C,IAAK,MACL,KAAM,OACN,KAAM,MACN,MAAO,OACT,EAEM,EAAY,CAAC,OAAQ,MAAO,QAAS,MAAM,EAajD,SAAgB,EAAe,EAAkB,EAA0B,EAAa,EAAW,CACjG,GAAI,CAAC,EAAS,KAAK,EAGjB,MAAO,GAGT,IAAI,EAEJ,GAAI,CACF,EAAQ,EAAc,EAAU,CAAM,CACxC,MAAQ,CAGN,MAFK,GAAmD,EAAnD,EAEE,EACT,CAEA,IAAM,EAAQ,IAAW,OAEzB,OAAO,EACJ,IAAK,GAAS,CACb,IAAM,EAAW,EAAU,OAAQ,GAAM,EAAK,UAAU,IAAI,CAAC,CAAC,CAAC,CAAC,IAAK,GACnE,EAAQ,EAAgB,GAAK,EAAiB,EAChD,EAEM,EAAW,EAAY,EAAK,MAAQ,EAAK,IAAI,YAAY,EAE/D,OAAO,EAAQ,GAAG,EAAS,KAAK,EAAE,IAAI,IAAa,CAAC,GAAG,EAAU,CAAQ,CAAC,CAAC,KAAK,GAAG,CACrF,CAAC,CAAC,CACD,KAAK,GAAG,CACb,CC/DA,SAAS,EAAe,EAAsD,CAC5E,GAAI,OAAO,GAAU,WACnB,MAAO,CAAE,QAAS,EAAO,SAAU,EAAG,QAAS,SAAU,EAG3D,IAAM,EAAW,EAAM,UAAY,EAMnC,OAJK,OAAO,SAAS,CAAQ,GACtB,GAAsD,EAAtD,EAGA,CACL,QAAS,EAAM,QACf,SAAU,OAAO,SAAS,CAAQ,EAAI,EAAW,EACjD,QAAS,EAAM,SAAW,UAC1B,KAAM,EAAM,IACd,CACF,CAEA,SAAS,EAAmB,EAAoC,EAAsB,CACpF,IAAI,EAAe,EACf,EAA8B,CAAC,EAC/B,EAA8C,KAElD,SAAS,GAAmB,CACtB,IAAU,OACZ,aAAa,CAAK,EAClB,EAAQ,KAEZ,CAEA,SAAS,GAAc,CACrB,EAAW,EACX,EAAe,EACf,EAAa,CAAC,CAChB,CAEA,SAAS,EAAQ,EAA4C,CAG3D,IAAM,EAAO,IAAiB,EAAI,EAAY,EAAI,EAC5C,EAA2B,CAAC,EAElC,IAAK,IAAM,KAAW,EAAM,CAC1B,IAAM,EAAO,EAAQ,SAAS,GAE1B,GAAQ,EAAU,EAAO,CAAI,GAC/B,EAAQ,KAAK,CAAO,CAExB,CAEA,GAAI,EAAQ,SAAW,EAAG,CACxB,IAAM,EAAa,IAAiB,EAQpC,OANA,EAAM,EAEF,EACK,EAAQ,CAAK,EAGf,IACT,CAEA,EAAW,EAKX,IAAM,EAAY,EAAQ,KAAM,GAAM,EAAE,SAAS,SAAW,EAAe,CAAC,EAY5E,OAVI,GACF,EAAM,EAEC,IAGT,EAAa,EACb,IACA,EAAQ,WAAW,EAAO,CAAY,EAE/B,KACT,CAEA,MAAO,CAAE,UAAS,OAAM,CAC1B,CAoBA,SAAgB,EAAa,EAAgD,CAAC,EAAG,EAAyB,CAAC,EAAW,CACpH,GAAM,CACJ,aAAc,EAAkB,IAChC,SAAS,EAAa,EACtB,iBAAiB,GACjB,kBAAkB,GAClB,KAAM,GACJ,EAEE,EAAe,OAAO,SAAS,CAAe,GAAK,EAAkB,EAAI,EAAkB,IAE7F,IAAiB,GACd,GAA2D,EAA3D,EAGP,IAAM,EAAW,IAAI,IACjB,EAAgC,CAAC,EACjC,EAA8B,CAAC,EAEnC,SAAS,GAA6B,CACpC,EAAe,CAAC,EAChB,EAAa,CAAC,EAEd,IAAK,IAAM,KAAK,EAAS,OAAO,EAC1B,EAAE,UAAY,UAAW,EAAa,KAAK,CAAC,EAC3C,EAAW,KAAK,CAAC,CAE1B,CAEA,SAAS,EAAW,EAAqB,EAA6B,CACpE,IAAM,EAAW,EAAc,EAAa,CAAM,EAC5C,EAAM,EAAqB,CAAQ,EAKzC,OAHA,EAAS,IAAI,EAAK,CAAE,WAAU,GAAG,EAAe,CAAK,CAAE,CAAC,EACxD,EAAqB,EAEd,CACT,CAEA,SAAS,EAAY,EAAsB,CACzC,IAAM,EAAU,EAAS,OAAO,CAAG,EAInC,OAFI,GAAS,EAAqB,EAE3B,CACT,CAEA,SAAS,EAAc,EAA8B,CAInD,OAAO,EAFK,EADK,EAAc,EAAa,CACX,CAEd,CAAG,CACxB,CAEA,IAAK,GAAM,CAAC,EAAa,KAAU,OAAO,QAAQ,CAAe,EAAG,CAClE,IAAM,EAAW,EAAc,EAAa,CAAM,EAC5C,EAAM,EAAqB,CAAQ,EAEzC,EAAS,IAAI,EAAK,CAAE,WAAU,GAAG,EAAe,CAAK,CAAE,CAAC,CAC1D,CAEA,EAAqB,EAErB,IAAM,EAAY,MAAyB,EAAc,CAAY,EAC/D,EAAU,MAAyB,EAAY,CAAY,EAC3D,EAAW,IAAI,IACf,EAAc,IAAI,IAExB,SAAS,EAAY,EAA8C,CACjE,OAAO,SAAqB,EAA4B,CACtD,GAAI,GAAc,CAAC,EAAW,EAAG,OAEjC,IAAM,EAAU,EAAM,QAAQ,CAAK,EAE9B,IAED,EAAQ,MAAQ,CAAC,EAAQ,KAAK,IAE9B,GAAgB,EAAM,eAAe,EAErC,GAAiB,EAAM,gBAAgB,EAE3C,EAAQ,QAAQ,CAAK,GACvB,CACF,CAEA,IAAM,EAAgB,EAAY,CAAS,EACrC,EAAc,EAAY,CAAO,EACjC,EAAK,IAAI,gBACX,EAAa,GAEjB,MAAO,CACL,KAAK,EAAqB,EAAiC,CACzD,IAAM,EAAM,EAAW,EAAa,CAAK,EAEzC,UAAa,CACX,EAAY,CAAG,CACjB,CACF,EAEA,IAAI,gBAA8B,CAChC,OAAO,EAAG,MACZ,EAEA,SAAgB,CACV,MAGJ,CADA,EAAa,GACb,EAAG,MAAM,EACT,IAAK,IAAM,KAAW,EAAU,EAAQ,EACxC,EAAS,MAAM,EACf,EAAU,MAAM,EAChB,EAAQ,MAAM,CAJL,CAKX,EAEA,IAAI,UAAoB,CACtB,OAAO,CACT,EAEA,cAAwC,CACtC,MAAO,CAAC,GAAG,EAAS,OAAO,CAAC,CAAC,CAAC,IAAK,IAAO,CACxC,SAAU,EAAE,SACZ,SAAU,EAAE,SAAS,IAAK,IAAO,CAAE,IAAK,EAAE,IAAK,UAAW,IAAI,IAAI,EAAE,SAAS,CAAE,EAAE,EACjF,QAAS,EAAE,OACb,EAAE,CACJ,EAEA,MAAM,EAAiC,CACrC,IAAM,EAAa,EAAY,IAAI,CAAM,GAAK,EAM9C,EAAY,IAAI,EAAQ,EAAa,CAAC,EAEtC,EAAO,iBAAiB,UAAW,CAA8B,EACjE,EAAO,iBAAiB,QAAS,CAA4B,EAE7D,IAAM,MAAsB,CAC1B,EAAO,oBAAoB,UAAW,CAA8B,EACpE,EAAO,oBAAoB,QAAS,CAA4B,EAChE,EAAS,OAAO,CAAO,EAEvB,IAAM,GAAa,EAAY,IAAI,CAAM,GAAK,GAAK,EAE/C,GAAa,EAAG,EAAY,OAAO,CAAM,EACxC,EAAY,IAAI,EAAQ,CAAS,CACxC,EAIA,OAFA,EAAS,IAAI,CAAO,EAEb,CACT,EAEA,CAAC,OAAO,UAAiB,CACvB,KAAK,QAAQ,CACf,EAEA,OAAO,EAA2B,CAChB,EAAc,CAEzB,GACE,GAA0C,EAA1C,CAET,CACF,CACF,CC5PA,SAAgB,EACd,EACA,EAAgD,CAAC,EACjD,EAAyB,CAAC,EACb,CACb,IAAI,EAAW,GAET,EAAQ,EAAa,EAAiB,CAC1C,GAAG,EACH,SAAY,IAAa,EAAQ,OAAO,GAAK,GAC/C,CAAC,EAED,MAAO,CACL,UAAiB,CACf,EAAW,EACb,EAEA,IAAI,QAAS,CACX,OAAO,CACT,EAEA,KAAK,EAAkB,EAAiC,CACtD,OAAO,EAAM,KAAK,EAAU,CAAK,CACnC,EAEA,YAAmB,CACjB,EAAW,EACb,EAEA,IAAI,gBAA8B,CAChC,OAAO,EAAM,cACf,EAEA,SAAgB,CACd,EAAM,QAAQ,CAChB,EAEA,IAAI,UAAoB,CACtB,OAAO,EAAM,QACf,EAEA,cAAe,CACb,OAAO,EAAM,aAAa,CAC5B,EAEA,MAAM,EAAiC,CACrC,OAAO,EAAM,MAAM,CAAM,CAC3B,EAEA,IAAI,QAAS,CACX,OAAO,CACT,EAEA,CAAC,OAAO,UAAiB,CACvB,KAAK,QAAQ,CACf,EAEA,OAAO,EAAwB,CAC7B,EAAM,OAAO,CAAQ,CACvB,CACF,CACF"}
|
|
1
|
+
{"version":3,"file":"keymap.cjs","names":[],"sources":["../src/errors.ts","../src/parser.ts","../src/conflicts.ts","../src/_dev.ts","../src/format.ts","../src/keymap.ts"],"sourcesContent":["/** Base class for all keymap errors. Use `instanceof KeymapError` to catch any keymap-originated error. */\nexport class KeymapError extends Error {\n constructor(message: string, opts?: ErrorOptions) {\n super(message, opts);\n this.name = new.target.name;\n Object.setPrototypeOf(this, new.target.prototype);\n }\n\n static is(err: unknown): err is KeymapError {\n return err instanceof KeymapError;\n }\n}\n\n/** Thrown when a shortcut string cannot be parsed — ambiguous or invalid key step. */\nexport class KeymapParseError extends KeymapError {}\n","import { KeymapParseError } from './errors';\n\nexport type ModifierKey = 'alt' | 'ctrl' | 'meta' | 'shift';\n\nexport type ShortcutStep = {\n key: string;\n modifiers: Set<ModifierKey>;\n};\n\nexport type Shortcut = ShortcutStep[];\n\nexport function detectModKey(): 'ctrl' | 'meta' {\n if (typeof navigator === 'undefined') return 'ctrl';\n\n const platform =\n (navigator as Navigator & { userAgentData?: { platform?: string } }).userAgentData?.platform ??\n navigator.platform ??\n '';\n\n return /mac/i.test(platform) ? 'meta' : 'ctrl';\n}\n\nconst MODIFIER_ALIASES_BASE: Record<string, ModifierKey> = {\n alt: 'alt',\n cmd: 'meta',\n command: 'meta',\n control: 'ctrl',\n ctrl: 'ctrl',\n meta: 'meta',\n opt: 'alt',\n option: 'alt',\n shift: 'shift',\n win: 'meta',\n};\n\nconst SPECIAL_KEY_ALIASES: Record<string, string> = {\n del: 'delete',\n down: 'arrowdown',\n esc: 'escape',\n left: 'arrowleft',\n right: 'arrowright',\n space: ' ',\n spacebar: ' ',\n up: 'arrowup',\n};\n\nfunction parseStepStrict(raw: string, modKey: 'ctrl' | 'meta'): ShortcutStep {\n const parts = raw\n .trim()\n .split('+')\n .filter(Boolean)\n .map((part) => part.toLowerCase());\n\n if (parts.length === 0) throw new KeymapParseError(`Invalid shortcut step: \"${raw}\"`);\n\n const aliases: Record<string, ModifierKey> = { ...MODIFIER_ALIASES_BASE, mod: modKey };\n const modifiers = new Set<ModifierKey>();\n const keyParts: string[] = [];\n\n for (const part of parts) {\n const modifier = Object.hasOwn(aliases, part) ? aliases[part]! : undefined;\n\n if (modifier) modifiers.add(modifier);\n else keyParts.push(part);\n }\n\n if (keyParts.length === 0) throw new KeymapParseError(`Invalid shortcut step: \"${raw}\"`);\n\n if (keyParts.length > 1) {\n throw new KeymapParseError(`Ambiguous shortcut step: \"${raw}\" — multiple non-modifier keys found`);\n }\n\n const rawKey = keyParts[0]!;\n const key = Object.hasOwn(SPECIAL_KEY_ALIASES, rawKey) ? SPECIAL_KEY_ALIASES[rawKey]! : rawKey;\n\n return { key, modifiers };\n}\n\nexport function parseStep(raw: string, modKey: 'ctrl' | 'meta' = detectModKey()): ShortcutStep | null {\n try {\n return parseStepStrict(raw, modKey);\n } catch {\n return null;\n }\n}\n\nexport function parseShortcut(raw: string, modKey: 'ctrl' | 'meta' = detectModKey()): Shortcut {\n const steps = raw.trim().split(/\\s+/).filter(Boolean);\n\n if (steps.length === 0) throw new KeymapParseError('Shortcut must contain at least one key step');\n\n return steps.map((step) => parseStepStrict(step, modKey));\n}\n\nexport function canonicalizeShortcut(steps: readonly ShortcutStep[]): string {\n return steps\n .map((step) => {\n const modifiers = [...step.modifiers].sort().join('+');\n\n return modifiers ? `${modifiers}+${step.key}` : step.key;\n })\n .join(' ');\n}\n\nexport function matchStep(event: KeyboardEvent, step: ShortcutStep): boolean {\n // Headless usage (SSR, non-DOM `EventTarget`s, hand-built test events) means `event` isn't\n // guaranteed to be a real `KeyboardEvent` at runtime even though the type says so — treat a\n // missing/non-string `key` as \"doesn't match\" rather than throwing inside the event listener.\n if (typeof event.key !== 'string') return false;\n\n if (event.key.toLowerCase() !== step.key) return false;\n\n const { modifiers } = step;\n\n return (\n event.altKey === modifiers.has('alt') &&\n event.ctrlKey === modifiers.has('ctrl') &&\n event.metaKey === modifiers.has('meta') &&\n event.shiftKey === modifiers.has('shift')\n );\n}\n","import type { ShortcutStep } from './parser';\nimport { canonicalizeShortcut, parseShortcut } from './parser';\nimport type { BindingEntry } from './types';\n\nexport interface ConflictOptions {\n modKey?: 'ctrl' | 'meta';\n trigger?: 'keydown' | 'keyup';\n}\n\nfunction isPrefixOf(shorter: readonly ShortcutStep[], longer: readonly ShortcutStep[]): boolean {\n if (shorter.length > longer.length) return false;\n\n return canonicalizeShortcut(shorter) === canonicalizeShortcut(longer.slice(0, shorter.length));\n}\n\n/**\n * Finds registered bindings that would conflict with a proposed shortcut — an exact duplicate, a\n * shorter binding that would shadow it as a chord prefix, or a longer binding it would itself\n * shadow. Only compares against entries sharing the same `trigger` — `'keydown'` and `'keyup'`\n * chords are matched independently and never conflict with each other.\n *\n * @example\n * const entries = map.listBindings();\n * findShortcutConflicts('g g', entries); // → the entry for 'g', if one is bound\n */\nexport function findShortcutConflicts(\n shortcut: string,\n entries: readonly BindingEntry[],\n options: ConflictOptions = {},\n): BindingEntry[] {\n const { modKey, trigger = 'keydown' } = options;\n\n // An empty/whitespace-only shortcut would be a trivial prefix of every entry — never report it\n // as a conflict.\n if (shortcut.trim() === '') return [];\n\n const steps = parseShortcut(shortcut, modKey);\n\n return entries.filter(\n (entry) => entry.trigger === trigger && (isPrefixOf(steps, entry.shortcut) || isPrefixOf(entry.shortcut, steps)),\n );\n}\n","const isDev = !(globalThis as { __KEYMAP_PROD__?: boolean }).__KEYMAP_PROD__;\n\n/** @internal */\nexport function warn(msg: string): void {\n if (isDev) console.warn(`[@vielzeug/keymap] ${msg}`);\n}\n\n/** @internal — Run fn only in dev builds. Use when dev-only logic goes beyond a single warn() / error() call. */\nexport function devOnly(fn: () => void): void {\n if (isDev) fn();\n}\n","import { warn } from './_dev';\nimport { detectModKey, parseShortcut } from './parser';\n\nconst KEY_SYMBOLS: Record<string, string> = {\n ' ': 'Space',\n arrowdown: '↓',\n arrowleft: '←',\n arrowright: '→',\n arrowup: '↑',\n backspace: '⌫',\n delete: '⌦',\n end: 'End',\n enter: '↵',\n escape: 'Esc',\n home: 'Home',\n pagedown: 'PgDn',\n pageup: 'PgUp',\n tab: '⇥',\n};\n\nconst MOD_SYMBOLS_MAC: Record<string, string> = {\n alt: '⌥',\n ctrl: '⌃',\n meta: '⌘',\n shift: '⇧',\n};\n\nconst MOD_LABELS_OTHER: Record<string, string> = {\n alt: 'Alt',\n ctrl: 'Ctrl',\n meta: 'Win',\n shift: 'Shift',\n};\n\nconst MOD_ORDER = ['ctrl', 'alt', 'shift', 'meta'] as const;\n\n/**\n * Formats a shortcut string into a human-readable display string.\n *\n * On Mac (when `modKey` is `'meta'`), uses standard Mac symbols (⌘, ⌥, ⇧, ⌃).\n * On other platforms, uses word labels (Ctrl, Alt, Shift, Win).\n *\n * @example\n * formatShortcut('mod+shift+p', 'meta') // '⇧⌘P' (canonical order: ctrl, alt, shift, meta)\n * formatShortcut('mod+shift+p', 'ctrl') // 'Ctrl+Shift+P'\n * formatShortcut('ctrl+k ctrl+s', 'meta') // '⌃K ⌃S'\n */\nexport function formatShortcut(shortcut: string, modKey: 'ctrl' | 'meta' = detectModKey()): string {\n if (!shortcut.trim()) {\n warn(`formatShortcut() received an empty shortcut string`);\n\n return '';\n }\n\n let steps: ReturnType<typeof parseShortcut>;\n\n try {\n steps = parseShortcut(shortcut, modKey);\n } catch {\n warn(`formatShortcut() received an invalid shortcut: \"${shortcut}\"`);\n\n return '';\n }\n\n const isMac = modKey === 'meta';\n\n return steps\n .map((step) => {\n const modParts = MOD_ORDER.filter((m) => step.modifiers.has(m)).map((m) =>\n isMac ? MOD_SYMBOLS_MAC[m] : MOD_LABELS_OTHER[m],\n );\n\n const keyLabel = KEY_SYMBOLS[step.key] ?? step.key.toUpperCase();\n\n return isMac ? `${modParts.join('')}${keyLabel}` : [...modParts, keyLabel].join('+');\n })\n .join(' ');\n}\n","import { warn } from './_dev';\nimport { KeymapError } from './errors';\nimport type { Shortcut, ShortcutStep } from './parser';\nimport { canonicalizeShortcut, detectModKey, matchStep, parseShortcut } from './parser';\nimport type { BindingEntry, BindingValue, ChordStateChange, Handler, Keymap, KeymapOptions, When } from './types';\n\ntype ParsedBinding = {\n handler: Handler;\n shortcut: Shortcut;\n trigger: 'keydown' | 'keyup';\n when?: When;\n};\n\ntype ChordTracker = ReturnType<typeof createChordTracker>;\ntype MountedTarget = {\n keydown: ChordTracker;\n keyup: ChordTracker;\n onKeydown: EventListener;\n onKeyup: EventListener;\n refs: number;\n};\n\nfunction resolveBinding(value: BindingValue): Omit<ParsedBinding, 'shortcut'> {\n if (typeof value === 'function') return { handler: value, trigger: 'keydown' };\n\n return {\n handler: value.handler,\n trigger: value.trigger ?? 'keydown',\n when: value.when,\n };\n}\n\ntype ChordTrackerCallbacks = {\n onChordStart?: (target: EventTarget, step: ShortcutStep, trigger: 'keydown' | 'keyup') => void;\n onChordProgress?: (target: EventTarget, steps: readonly ShortcutStep[], trigger: 'keydown' | 'keyup') => void;\n onChordTimeout?: (target: EventTarget, trigger: 'keydown' | 'keyup') => void;\n};\n\nfunction createChordTracker(\n getBindings: () => ParsedBinding[],\n chordTimeout: number,\n target: EventTarget,\n trigger: 'keydown' | 'keyup',\n callbacks?: ChordTrackerCallbacks,\n) {\n let pendingIndex = 0;\n let candidates: ParsedBinding[] = [];\n let timer: ReturnType<typeof setTimeout> | undefined;\n let pendingSteps: ShortcutStep[] = [];\n\n function reset(emitTimeout = false): void {\n if (timer !== undefined) clearTimeout(timer);\n\n // Emit timeout only if explicitly requested (from timeout event)\n if (emitTimeout && pendingIndex > 0 && callbacks?.onChordTimeout) {\n try {\n callbacks.onChordTimeout(target, trigger);\n } catch (err) {\n warn(`onChordState callback error: ${err instanceof Error ? err.message : String(err)}`);\n }\n }\n\n timer = undefined;\n pendingIndex = 0;\n candidates = [];\n pendingSteps = [];\n }\n\n function advance(event: KeyboardEvent): ParsedBinding | undefined {\n const pool = pendingIndex === 0 ? getBindings() : candidates;\n const matched = pool.filter((binding) => {\n const step = binding.shortcut[pendingIndex];\n\n return step !== undefined && matchStep(event, step);\n });\n\n if (matched.length === 0) {\n const retryFromRoot = pendingIndex !== 0;\n\n reset();\n\n return retryFromRoot ? advance(event) : undefined;\n }\n\n if (timer !== undefined) clearTimeout(timer);\n\n timer = undefined;\n\n const completed = matched.find((binding) => binding.shortcut.length === pendingIndex + 1);\n\n if (completed) {\n reset();\n\n return completed;\n }\n\n // New step in chord progression\n const currentStep = matched[0]!.shortcut[pendingIndex];\n pendingSteps = matched[0]!.shortcut.slice(0, pendingIndex + 1);\n\n // Emit started or progressed\n if (pendingIndex === 0 && callbacks?.onChordStart) {\n try {\n callbacks.onChordStart(target, currentStep, trigger);\n } catch (err) {\n warn(`onChordState callback error: ${err instanceof Error ? err.message : String(err)}`);\n }\n } else if (pendingIndex > 0 && callbacks?.onChordProgress) {\n try {\n callbacks.onChordProgress(target, pendingSteps, trigger);\n } catch (err) {\n warn(`onChordState callback error: ${err instanceof Error ? err.message : String(err)}`);\n }\n }\n\n candidates = matched;\n pendingIndex += 1;\n timer = setTimeout(() => reset(true), chordTimeout);\n\n return undefined;\n }\n\n return { advance, reset: () => reset() };\n}\n\n/**\n * Creates a headless keyboard shortcut manager with target-local chord state.\n *\n * Pass a bindings map of shortcut strings to handlers or `BindingOptions`, then call\n * `.mount(target)` to attach to any `EventTarget`. Supports chord sequences\n * (e.g. `\"ctrl+k ctrl+s\"`), per-binding `when` guards, `trigger` (keydown/keyup),\n * and dynamic `bind`/`unbind`.\n *\n * @example\n * const map = createKeymap({\n * 'mod+k mod+s': () => save(),\n * 'mod+shift+p': () => openPalette(),\n * 'g g': () => goToTop(),\n * esc: { handler: closePanel, when: (event) => !isEditableTarget(event.target) },\n * space: { handler: togglePlay, trigger: 'keyup' },\n * }, { modKey: 'ctrl' });\n * const unmount = map.mount(document);\n */\nexport function createKeymap(initialBindings: Record<string, BindingValue> = {}, options: KeymapOptions = {}): Keymap {\n const {\n chordTimeout: rawChordTimeout = 1000,\n modKey = detectModKey(),\n preventDefault = true,\n stopPropagation = false,\n when: globalWhen,\n onChordState: userOnChordState,\n } = options;\n const chordTimeout = Number.isFinite(rawChordTimeout) && rawChordTimeout > 0 ? rawChordTimeout : 1000;\n\n if (chordTimeout !== rawChordTimeout) {\n warn(`chordTimeout must be a positive finite number; received ${rawChordTimeout}. Using default of 1000ms.`);\n }\n\n const bindings = new Map<string, ParsedBinding>();\n const mounted = new Map<EventTarget, MountedTarget>();\n const disposalController = new AbortController();\n let bindingsDown: ParsedBinding[] = [];\n let bindingsUp: ParsedBinding[] = [];\n let disposed = false;\n\n function assertActive(): void {\n if (disposed) throw new KeymapError('Keymap is disposed');\n }\n\n function rebuildTriggerCaches(): void {\n bindingsDown = [];\n bindingsUp = [];\n\n for (const binding of bindings.values()) {\n if (binding.trigger === 'keydown') bindingsDown.push(binding);\n else bindingsUp.push(binding);\n }\n }\n\n function bindingKey(shortcut: string): string {\n return canonicalizeShortcut(parseShortcut(shortcut, modKey));\n }\n\n function addBinding(shortcut: string, value: BindingValue): string {\n const parsed = parseShortcut(shortcut, modKey);\n const key = canonicalizeShortcut(parsed);\n\n bindings.set(key, { shortcut: parsed, ...resolveBinding(value) });\n rebuildTriggerCaches();\n\n return key;\n }\n\n function removeByKey(key: string): boolean {\n const existed = bindings.delete(key);\n\n if (existed) rebuildTriggerCaches();\n\n return existed;\n }\n\n function emitChordState(change: ChordStateChange): void {\n if (!userOnChordState) return;\n\n try {\n userOnChordState(change);\n } catch (err) {\n warn(`onChordState callback error: ${err instanceof Error ? err.message : String(err)}`);\n }\n }\n\n function makeHandler(target: EventTarget, chord: ChordTracker): EventListener {\n return (event) => {\n const path = typeof event.composedPath === 'function' ? event.composedPath() : [];\n const nearestMountedTarget = path.find((pathTarget) => mounted.has(pathTarget));\n\n if (nearestMountedTarget && nearestMountedTarget !== target) return;\n\n const keyboardEvent = event as KeyboardEvent;\n\n if (disposed) return;\n\n // Track chord progression (independent of guards)\n const binding = chord.advance(keyboardEvent);\n\n // Check guards AFTER tracking chord\n if (globalWhen && !globalWhen(keyboardEvent)) return;\n\n if (!binding || (binding.when && !binding.when(keyboardEvent))) return;\n\n if (preventDefault) keyboardEvent.preventDefault();\n\n if (stopPropagation) keyboardEvent.stopPropagation();\n\n binding.handler(keyboardEvent);\n };\n }\n\n for (const [shortcut, value] of Object.entries(initialBindings)) addBinding(shortcut, value);\n\n return {\n bind(shortcut: string, value: BindingValue): () => void {\n assertActive();\n\n const key = addBinding(shortcut, value);\n\n return () => {\n if (!disposed) removeByKey(key);\n };\n },\n\n get disposalSignal(): AbortSignal {\n return disposalController.signal;\n },\n\n dispose(): void {\n if (disposed) return;\n\n disposed = true;\n disposalController.abort();\n\n for (const [target, record] of mounted) {\n target.removeEventListener('keydown', record.onKeydown);\n target.removeEventListener('keyup', record.onKeyup);\n record.keydown.reset();\n record.keyup.reset();\n }\n\n mounted.clear();\n bindings.clear();\n bindingsDown = [];\n bindingsUp = [];\n },\n\n get disposed(): boolean {\n return disposed;\n },\n\n listBindings(): readonly BindingEntry[] {\n return [...bindings.values()].map((binding) => ({\n shortcut: binding.shortcut.map((step) => ({ key: step.key, modifiers: new Set(step.modifiers) })),\n trigger: binding.trigger,\n }));\n },\n\n mount(target: EventTarget): () => void {\n assertActive();\n\n let record = mounted.get(target);\n\n if (!record) {\n const keydown = createChordTracker(() => bindingsDown, chordTimeout, target, 'keydown', {\n onChordProgress: (t, steps, trigger) => emitChordState({ steps, target: t, trigger, type: 'progressed' }),\n onChordStart: (t, step, trigger) => emitChordState({ step, target: t, trigger, type: 'started' }),\n onChordTimeout: (t, trigger) => emitChordState({ target: t, trigger, type: 'timeout' }),\n });\n const keyup = createChordTracker(() => bindingsUp, chordTimeout, target, 'keyup', {\n onChordProgress: (t, steps, trigger) => emitChordState({ steps, target: t, trigger, type: 'progressed' }),\n onChordStart: (t, step, trigger) => emitChordState({ step, target: t, trigger, type: 'started' }),\n onChordTimeout: (t, trigger) => emitChordState({ target: t, trigger, type: 'timeout' }),\n });\n const onKeydown = makeHandler(target, keydown);\n const onKeyup = makeHandler(target, keyup);\n\n record = { keydown, keyup, onKeydown, onKeyup, refs: 0 };\n mounted.set(target, record);\n target.addEventListener('keydown', onKeydown);\n target.addEventListener('keyup', onKeyup);\n }\n\n record.refs += 1;\n\n let unmounted = false;\n\n return () => {\n if (unmounted) return;\n\n unmounted = true;\n record!.refs -= 1;\n\n if (record?.refs > 0) return;\n\n target.removeEventListener('keydown', record?.onKeydown);\n target.removeEventListener('keyup', record?.onKeyup);\n record?.keydown.reset();\n record?.keyup.reset();\n mounted.delete(target);\n };\n },\n\n [Symbol.dispose](): void {\n this.dispose();\n },\n\n unbind(shortcut: string): void {\n assertActive();\n\n if (!removeByKey(bindingKey(shortcut))) {\n warn(`unbind() called for unknown shortcut: \"${shortcut}\"`);\n }\n },\n };\n}\n"],"mappings":"mEACA,IAAa,EAAb,MAAa,UAAoB,KAAM,CACrC,YAAY,EAAiB,EAAqB,CAChD,MAAM,EAAS,CAAI,EACnB,KAAK,KAAO,WAAW,KACvB,OAAO,eAAe,KAAM,WAAW,SAAS,CAClD,CAEA,OAAO,GAAG,EAAkC,CAC1C,OAAO,aAAe,CACxB,CACF,EAGa,EAAb,cAAsC,CAAY,CAAC,ECHnD,SAAgB,GAAgC,CAC9C,GAAI,OAAO,UAAc,IAAa,MAAO,OAE7C,IAAM,EACH,UAAoE,eAAe,UACpF,UAAU,UACV,GAEF,MAAO,OAAO,KAAK,CAAQ,EAAI,OAAS,MAC1C,CAEA,IAAM,EAAqD,CACzD,IAAK,MACL,IAAK,OACL,QAAS,OACT,QAAS,OACT,KAAM,OACN,KAAM,OACN,IAAK,MACL,OAAQ,MACR,MAAO,QACP,IAAK,MACP,EAEM,EAA8C,CAClD,IAAK,SACL,KAAM,YACN,IAAK,SACL,KAAM,YACN,MAAO,aACP,MAAO,IACP,SAAU,IACV,GAAI,SACN,EAEA,SAAS,EAAgB,EAAa,EAAuC,CAC3E,IAAM,EAAQ,EACX,KAAK,CAAC,CACN,MAAM,GAAG,CAAC,CACV,OAAO,OAAO,CAAC,CACf,IAAK,GAAS,EAAK,YAAY,CAAC,EAEnC,GAAI,EAAM,SAAW,EAAG,MAAM,IAAI,EAAiB,2BAA2B,EAAI,EAAE,EAEpF,IAAM,EAAuC,CAAE,GAAG,EAAuB,IAAK,CAAO,EAC/E,EAAY,IAAI,IAChB,EAAqB,CAAC,EAE5B,IAAK,IAAM,KAAQ,EAAO,CACxB,IAAM,EAAW,OAAO,OAAO,EAAS,CAAI,EAAI,EAAQ,GAAS,IAAA,GAE7D,EAAU,EAAU,IAAI,CAAQ,EAC/B,EAAS,KAAK,CAAI,CACzB,CAEA,GAAI,EAAS,SAAW,EAAG,MAAM,IAAI,EAAiB,2BAA2B,EAAI,EAAE,EAEvF,GAAI,EAAS,OAAS,EACpB,MAAM,IAAI,EAAiB,6BAA6B,EAAI,qCAAqC,EAGnG,IAAM,EAAS,EAAS,GAGxB,MAAO,CAAE,IAFG,OAAO,OAAO,EAAqB,CAAM,EAAI,EAAoB,GAAW,EAE1E,WAAU,CAC1B,CAEA,SAAgB,EAAU,EAAa,EAA0B,EAAa,EAAwB,CACpG,GAAI,CACF,OAAO,EAAgB,EAAK,CAAM,CACpC,MAAQ,CACN,OAAO,IACT,CACF,CAEA,SAAgB,EAAc,EAAa,EAA0B,EAAa,EAAa,CAC7F,IAAM,EAAQ,EAAI,KAAK,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,OAAO,OAAO,EAEpD,GAAI,EAAM,SAAW,EAAG,MAAM,IAAI,EAAiB,6CAA6C,EAEhG,OAAO,EAAM,IAAK,GAAS,EAAgB,EAAM,CAAM,CAAC,CAC1D,CAEA,SAAgB,EAAqB,EAAwC,CAC3E,OAAO,EACJ,IAAK,GAAS,CACb,IAAM,EAAY,CAAC,GAAG,EAAK,SAAS,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,GAAG,EAErD,OAAO,EAAY,GAAG,EAAU,GAAG,EAAK,MAAQ,EAAK,GACvD,CAAC,CAAC,CACD,KAAK,GAAG,CACb,CAEA,SAAgB,EAAU,EAAsB,EAA6B,CAM3E,GAFI,OAAO,EAAM,KAAQ,UAErB,EAAM,IAAI,YAAY,IAAM,EAAK,IAAK,MAAO,GAEjD,GAAM,CAAE,aAAc,EAEtB,OACE,EAAM,SAAW,EAAU,IAAI,KAAK,GACpC,EAAM,UAAY,EAAU,IAAI,MAAM,GACtC,EAAM,UAAY,EAAU,IAAI,MAAM,GACtC,EAAM,WAAa,EAAU,IAAI,OAAO,CAE5C,CC/GA,SAAS,EAAW,EAAkC,EAA0C,CAG9F,OAFI,EAAQ,OAAS,EAAO,OAAe,GAEpC,EAAqB,CAAO,IAAM,EAAqB,EAAO,MAAM,EAAG,EAAQ,MAAM,CAAC,CAC/F,CAYA,SAAgB,EACd,EACA,EACA,EAA2B,CAAC,EACZ,CAChB,GAAM,CAAE,SAAQ,UAAU,WAAc,EAIxC,GAAI,EAAS,KAAK,IAAM,GAAI,MAAO,CAAC,EAEpC,IAAM,EAAQ,EAAc,EAAU,CAAM,EAE5C,OAAO,EAAQ,OACZ,GAAU,EAAM,UAAY,IAAY,EAAW,EAAO,EAAM,QAAQ,GAAK,EAAW,EAAM,SAAU,CAAK,EAChH,CACF,CEtCA,IAAM,EAAsC,CAC1C,IAAK,QACL,UAAW,IACX,UAAW,IACX,WAAY,IACZ,QAAS,IACT,UAAW,IACX,OAAQ,IACR,IAAK,MACL,MAAO,IACP,OAAQ,MACR,KAAM,OACN,SAAU,OACV,OAAQ,OACR,IAAK,GACP,EAEM,EAA0C,CAC9C,IAAK,IACL,KAAM,IACN,KAAM,IACN,MAAO,GACT,EAEM,EAA2C,CAC/C,IAAK,MACL,KAAM,OACN,KAAM,MACN,MAAO,OACT,EAEM,EAAY,CAAC,OAAQ,MAAO,QAAS,MAAM,EAajD,SAAgB,EAAe,EAAkB,EAA0B,EAAa,EAAW,CACjG,GAAI,CAAC,EAAS,KAAK,EAGjB,MAAO,GAGT,IAAI,EAEJ,GAAI,CACF,EAAQ,EAAc,EAAU,CAAM,CACxC,MAAQ,CAGN,MAFK,GAAmD,EAAnD,EAEE,EACT,CAEA,IAAM,EAAQ,IAAW,OAEzB,OAAO,EACJ,IAAK,GAAS,CACb,IAAM,EAAW,EAAU,OAAQ,GAAM,EAAK,UAAU,IAAI,CAAC,CAAC,CAAC,CAAC,IAAK,GACnE,EAAQ,EAAgB,GAAK,EAAiB,EAChD,EAEM,EAAW,EAAY,EAAK,MAAQ,EAAK,IAAI,YAAY,EAE/D,OAAO,EAAQ,GAAG,EAAS,KAAK,EAAE,IAAI,IAAa,CAAC,GAAG,EAAU,CAAQ,CAAC,CAAC,KAAK,GAAG,CACrF,CAAC,CAAC,CACD,KAAK,GAAG,CACb,CCvDA,SAAS,EAAe,EAAsD,CAG5E,OAFI,OAAO,GAAU,WAAmB,CAAE,QAAS,EAAO,QAAS,SAAU,EAEtE,CACL,QAAS,EAAM,QACf,QAAS,EAAM,SAAW,UAC1B,KAAM,EAAM,IACd,CACF,CAQA,SAAS,EACP,EACA,EACA,EACA,EACA,EACA,CACA,IAAI,EAAe,EACf,EAA8B,CAAC,EAC/B,EACA,EAA+B,CAAC,EAEpC,SAAS,EAAM,EAAc,GAAa,CAIxC,GAHI,IAAU,IAAA,IAAW,aAAa,CAAK,EAGvC,GAAe,EAAe,GAAK,GAAW,eAChD,GAAI,CACF,EAAU,eAAe,EAAQ,CAAO,CAC1C,OAAS,EAAK,CACP,GAAgC,aAAe,MAAQ,EAAI,QAAU,OAAO,CAAG,EAA/E,CACP,CAGF,EAAQ,IAAA,GACR,EAAe,EACf,EAAa,CAAC,EACd,EAAe,CAAC,CAClB,CAEA,SAAS,EAAQ,EAAiD,CAEhE,IAAM,GADO,IAAiB,EAAI,EAAY,EAAI,EAAA,CAC7B,OAAQ,GAAY,CACvC,IAAM,EAAO,EAAQ,SAAS,GAE9B,OAAO,IAAS,IAAA,IAAa,EAAU,EAAO,CAAI,CACpD,CAAC,EAED,GAAI,EAAQ,SAAW,EAAG,CACxB,IAAM,EAAgB,IAAiB,EAIvC,OAFA,EAAM,EAEC,EAAgB,EAAQ,CAAK,EAAI,IAAA,EAC1C,CAEI,IAAU,IAAA,IAAW,aAAa,CAAK,EAE3C,EAAQ,IAAA,GAER,IAAM,EAAY,EAAQ,KAAM,GAAY,EAAQ,SAAS,SAAW,EAAe,CAAC,EAExF,GAAI,EAGF,OAFA,EAAM,EAEC,EAIT,IAAM,EAAc,EAAQ,EAAE,CAAE,SAAS,GAIzC,GAHA,EAAe,EAAQ,EAAE,CAAE,SAAS,MAAM,EAAG,EAAe,CAAC,EAGzD,IAAiB,GAAK,GAAW,aACnC,GAAI,CACF,EAAU,aAAa,EAAQ,EAAa,CAAO,CACrD,OAAS,EAAK,CACP,GAAgC,aAAe,MAAQ,EAAI,QAAU,OAAO,CAAG,EAA/E,CACP,MACK,GAAI,EAAe,GAAK,GAAW,gBACxC,GAAI,CACF,EAAU,gBAAgB,EAAQ,EAAc,CAAO,CACzD,OAAS,EAAK,CACP,GAAgC,aAAe,MAAQ,EAAI,QAAU,OAAO,CAAG,EAA/E,CACP,CAGF,EAAa,EACb,GAAgB,EAChB,EAAQ,eAAiB,EAAM,EAAI,EAAG,CAAY,CAGpD,CAEA,MAAO,CAAE,UAAS,UAAa,EAAM,CAAE,CACzC,CAoBA,SAAgB,EAAa,EAAgD,CAAC,EAAG,EAAyB,CAAC,EAAW,CACpH,GAAM,CACJ,aAAc,EAAkB,IAChC,SAAS,EAAa,EACtB,iBAAiB,GACjB,kBAAkB,GAClB,KAAM,EACN,aAAc,GACZ,EACE,EAAe,OAAO,SAAS,CAAe,GAAK,EAAkB,EAAI,EAAkB,IAE7F,IAAiB,GACd,GAA2D,EAA3D,EAGP,IAAM,EAAW,IAAI,IACf,EAAU,IAAI,IACd,EAAqB,IAAI,gBAC3B,EAAgC,CAAC,EACjC,EAA8B,CAAC,EAC/B,EAAW,GAEf,SAAS,GAAqB,CAC5B,GAAI,EAAU,MAAM,IAAI,EAAY,oBAAoB,CAC1D,CAEA,SAAS,GAA6B,CACpC,EAAe,CAAC,EAChB,EAAa,CAAC,EAEd,IAAK,IAAM,KAAW,EAAS,OAAO,EAChC,EAAQ,UAAY,UAAW,EAAa,KAAK,CAAO,EACvD,EAAW,KAAK,CAAO,CAEhC,CAEA,SAAS,EAAW,EAA0B,CAC5C,OAAO,EAAqB,EAAc,EAAU,CAAM,CAAC,CAC7D,CAEA,SAAS,EAAW,EAAkB,EAA6B,CACjE,IAAM,EAAS,EAAc,EAAU,CAAM,EACvC,EAAM,EAAqB,CAAM,EAKvC,OAHA,EAAS,IAAI,EAAK,CAAE,SAAU,EAAQ,GAAG,EAAe,CAAK,CAAE,CAAC,EAChE,EAAqB,EAEd,CACT,CAEA,SAAS,EAAY,EAAsB,CACzC,IAAM,EAAU,EAAS,OAAO,CAAG,EAInC,OAFI,GAAS,EAAqB,EAE3B,CACT,CAEA,SAAS,EAAe,EAAgC,CACjD,KAEL,GAAI,CACF,EAAiB,CAAM,CACzB,OAAS,EAAK,CACP,GAAgC,aAAe,MAAQ,EAAI,QAAU,OAAO,CAAG,EAA/E,CACP,CACF,CAEA,SAAS,EAAY,EAAqB,EAAoC,CAC5E,MAAQ,IAAU,CAEhB,IAAM,GADO,OAAO,EAAM,cAAiB,WAAa,EAAM,aAAa,EAAI,CAAC,EAAA,CAC9C,KAAM,GAAe,EAAQ,IAAI,CAAU,CAAC,EAE9E,GAAI,GAAwB,IAAyB,EAAQ,OAE7D,IAAM,EAAgB,EAEtB,GAAI,EAAU,OAGd,IAAM,EAAU,EAAM,QAAQ,CAAa,EAGvC,GAAc,CAAC,EAAW,CAAa,GAEvC,CAAC,GAAY,EAAQ,MAAQ,CAAC,EAAQ,KAAK,CAAa,IAExD,GAAgB,EAAc,eAAe,EAE7C,GAAiB,EAAc,gBAAgB,EAEnD,EAAQ,QAAQ,CAAa,EAC/B,CACF,CAEA,IAAK,GAAM,CAAC,EAAU,KAAU,OAAO,QAAQ,CAAe,EAAG,EAAW,EAAU,CAAK,EAE3F,MAAO,CACL,KAAK,EAAkB,EAAiC,CACtD,EAAa,EAEb,IAAM,EAAM,EAAW,EAAU,CAAK,EAEtC,UAAa,CACN,GAAU,EAAY,CAAG,CAChC,CACF,EAEA,IAAI,gBAA8B,CAChC,OAAO,EAAmB,MAC5B,EAEA,SAAgB,CACV,MAGJ,CADA,EAAW,GACX,EAAmB,MAAM,EAEzB,IAAK,GAAM,CAAC,EAAQ,KAAW,EAC7B,EAAO,oBAAoB,UAAW,EAAO,SAAS,EACtD,EAAO,oBAAoB,QAAS,EAAO,OAAO,EAClD,EAAO,QAAQ,MAAM,EACrB,EAAO,MAAM,MAAM,EAGrB,EAAQ,MAAM,EACd,EAAS,MAAM,EACf,EAAe,CAAC,EAChB,EAAa,CAAC,CAZW,CAa3B,EAEA,IAAI,UAAoB,CACtB,OAAO,CACT,EAEA,cAAwC,CACtC,MAAO,CAAC,GAAG,EAAS,OAAO,CAAC,CAAC,CAAC,IAAK,IAAa,CAC9C,SAAU,EAAQ,SAAS,IAAK,IAAU,CAAE,IAAK,EAAK,IAAK,UAAW,IAAI,IAAI,EAAK,SAAS,CAAE,EAAE,EAChG,QAAS,EAAQ,OACnB,EAAE,CACJ,EAEA,MAAM,EAAiC,CACrC,EAAa,EAEb,IAAI,EAAS,EAAQ,IAAI,CAAM,EAE/B,GAAI,CAAC,EAAQ,CACX,IAAM,EAAU,MAAyB,EAAc,EAAc,EAAQ,UAAW,CACtF,iBAAkB,EAAG,EAAO,IAAY,EAAe,CAAE,QAAO,OAAQ,EAAG,UAAS,KAAM,YAAa,CAAC,EACxG,cAAe,EAAG,EAAM,IAAY,EAAe,CAAE,OAAM,OAAQ,EAAG,UAAS,KAAM,SAAU,CAAC,EAChG,gBAAiB,EAAG,IAAY,EAAe,CAAE,OAAQ,EAAG,UAAS,KAAM,SAAU,CAAC,CACxF,CAAC,EACK,EAAQ,MAAyB,EAAY,EAAc,EAAQ,QAAS,CAChF,iBAAkB,EAAG,EAAO,IAAY,EAAe,CAAE,QAAO,OAAQ,EAAG,UAAS,KAAM,YAAa,CAAC,EACxG,cAAe,EAAG,EAAM,IAAY,EAAe,CAAE,OAAM,OAAQ,EAAG,UAAS,KAAM,SAAU,CAAC,EAChG,gBAAiB,EAAG,IAAY,EAAe,CAAE,OAAQ,EAAG,UAAS,KAAM,SAAU,CAAC,CACxF,CAAC,EACK,EAAY,EAAY,EAAQ,CAAO,EACvC,EAAU,EAAY,EAAQ,CAAK,EAEzC,EAAS,CAAE,UAAS,QAAO,YAAW,UAAS,KAAM,CAAE,EACvD,EAAQ,IAAI,EAAQ,CAAM,EAC1B,EAAO,iBAAiB,UAAW,CAAS,EAC5C,EAAO,iBAAiB,QAAS,CAAO,CAC1C,CAEA,EAAO,MAAQ,EAEf,IAAI,EAAY,GAEhB,UAAa,CACP,IAEJ,EAAY,GACZ,IAAQ,KAEJ,KAAQ,KAAO,KAEnB,EAAO,oBAAoB,UAAW,GAAQ,SAAS,EACvD,EAAO,oBAAoB,QAAS,GAAQ,OAAO,EACnD,GAAQ,QAAQ,MAAM,EACtB,GAAQ,MAAM,MAAM,EACpB,EAAQ,OAAO,CAAM,GACvB,CACF,EAEA,CAAC,OAAO,UAAiB,CACvB,KAAK,QAAQ,CACf,EAEA,OAAO,EAAwB,CAC7B,EAAa,EAER,EAAY,EAAW,CAAQ,CAAC,GAC9B,GAA0C,EAA1C,CAET,CACF,CACF"}
|
package/dist/keymap.d.ts
CHANGED
|
@@ -1,22 +1,21 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { BindingValue, Keymap, KeymapOptions } from './types';
|
|
2
2
|
/**
|
|
3
|
-
* Creates a headless keyboard shortcut manager.
|
|
3
|
+
* Creates a headless keyboard shortcut manager with target-local chord state.
|
|
4
4
|
*
|
|
5
5
|
* Pass a bindings map of shortcut strings to handlers or `BindingOptions`, then call
|
|
6
6
|
* `.mount(target)` to attach to any `EventTarget`. Supports chord sequences
|
|
7
7
|
* (e.g. `"ctrl+k ctrl+s"`), per-binding `when` guards, `trigger` (keydown/keyup),
|
|
8
|
-
*
|
|
8
|
+
* and dynamic `bind`/`unbind`.
|
|
9
9
|
*
|
|
10
10
|
* @example
|
|
11
11
|
* const map = createKeymap({
|
|
12
12
|
* 'mod+k mod+s': () => save(),
|
|
13
13
|
* 'mod+shift+p': () => openPalette(),
|
|
14
14
|
* 'g g': () => goToTop(),
|
|
15
|
-
* esc: { handler: closePanel, when: () =>
|
|
15
|
+
* esc: { handler: closePanel, when: (event) => !isEditableTarget(event.target) },
|
|
16
16
|
* space: { handler: togglePlay, trigger: 'keyup' },
|
|
17
17
|
* }, { modKey: 'ctrl' });
|
|
18
18
|
* const unmount = map.mount(document);
|
|
19
19
|
*/
|
|
20
20
|
export declare function createKeymap(initialBindings?: Record<string, BindingValue>, options?: KeymapOptions): Keymap;
|
|
21
|
-
export type { BindingOptions };
|
|
22
21
|
//# sourceMappingURL=keymap.d.ts.map
|
package/dist/keymap.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"keymap.d.ts","sourceRoot":"","sources":["../src/keymap.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"keymap.d.ts","sourceRoot":"","sources":["../src/keymap.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAgB,YAAY,EAA6B,MAAM,EAAE,aAAa,EAAQ,MAAM,SAAS,CAAC;AAyHlH;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,YAAY,CAAC,eAAe,GAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAM,EAAE,OAAO,GAAE,aAAkB,GAAG,MAAM,CAuMpH"}
|
package/dist/keymap.iife.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
var Keymap=(function(e){Object.defineProperty(e,Symbol.toStringTag,{value:`Module`});var t=class e extends Error{constructor(e,t){super(e,t),this.name=new.target.name,Object.setPrototypeOf(this,new.target.prototype)}static is(t){return t instanceof e}},n=class extends t{
|
|
1
|
+
var Keymap=(function(e){Object.defineProperty(e,Symbol.toStringTag,{value:`Module`});var t=class e extends Error{constructor(e,t){super(e,t),this.name=new.target.name,Object.setPrototypeOf(this,new.target.prototype)}static is(t){return t instanceof e}},n=class extends t{};function r(){if(typeof navigator>`u`)return`ctrl`;let e=navigator.userAgentData?.platform??navigator.platform??``;return/mac/i.test(e)?`meta`:`ctrl`}var i={alt:`alt`,cmd:`meta`,command:`meta`,control:`ctrl`,ctrl:`ctrl`,meta:`meta`,opt:`alt`,option:`alt`,shift:`shift`,win:`meta`},a={del:`delete`,down:`arrowdown`,esc:`escape`,left:`arrowleft`,right:`arrowright`,space:` `,spacebar:` `,up:`arrowup`};function o(e,t){let r=e.trim().split(`+`).filter(Boolean).map(e=>e.toLowerCase());if(r.length===0)throw new n(`Invalid shortcut step: "${e}"`);let o={...i,mod:t},s=new Set,c=[];for(let e of r){let t=Object.hasOwn(o,e)?o[e]:void 0;t?s.add(t):c.push(e)}if(c.length===0)throw new n(`Invalid shortcut step: "${e}"`);if(c.length>1)throw new n(`Ambiguous shortcut step: "${e}" — multiple non-modifier keys found`);let l=c[0];return{key:Object.hasOwn(a,l)?a[l]:l,modifiers:s}}function s(e,t=r()){try{return o(e,t)}catch{return null}}function c(e,t=r()){let i=e.trim().split(/\s+/).filter(Boolean);if(i.length===0)throw new n(`Shortcut must contain at least one key step`);return i.map(e=>o(e,t))}function l(e){return e.map(e=>{let t=[...e.modifiers].sort().join(`+`);return t?`${t}+${e.key}`:e.key}).join(` `)}function u(e,t){if(typeof e.key!=`string`||e.key.toLowerCase()!==t.key)return!1;let{modifiers:n}=t;return e.altKey===n.has(`alt`)&&e.ctrlKey===n.has(`ctrl`)&&e.metaKey===n.has(`meta`)&&e.shiftKey===n.has(`shift`)}function d(e,t){return e.length>t.length?!1:l(e)===l(t.slice(0,e.length))}function f(e,t,n={}){let{modKey:r,trigger:i=`keydown`}=n;if(e.trim()===``)return[];let a=c(e,r);return t.filter(e=>e.trigger===i&&(d(a,e.shortcut)||d(e.shortcut,a)))}var p={" ":`Space`,arrowdown:`↓`,arrowleft:`←`,arrowright:`→`,arrowup:`↑`,backspace:`⌫`,delete:`⌦`,end:`End`,enter:`↵`,escape:`Esc`,home:`Home`,pagedown:`PgDn`,pageup:`PgUp`,tab:`⇥`},m={alt:`⌥`,ctrl:`⌃`,meta:`⌘`,shift:`⇧`},h={alt:`Alt`,ctrl:`Ctrl`,meta:`Win`,shift:`Shift`},g=[`ctrl`,`alt`,`shift`,`meta`];function _(e,t=r()){if(!e.trim())return``;let n;try{n=c(e,t)}catch{return`${e}`,``}let i=t===`meta`;return n.map(e=>{let t=g.filter(t=>e.modifiers.has(t)).map(e=>i?m[e]:h[e]),n=p[e.key]??e.key.toUpperCase();return i?`${t.join(``)}${n}`:[...t,n].join(`+`)}).join(` `)}function v(e){return typeof e==`function`?{handler:e,trigger:`keydown`}:{handler:e.handler,trigger:e.trigger??`keydown`,when:e.when}}function y(e,t,n,r,i){let a=0,o=[],s,c=[];function l(e=!1){if(s!==void 0&&clearTimeout(s),e&&a>0&&i?.onChordTimeout)try{i.onChordTimeout(n,r)}catch(e){`${e instanceof Error?e.message:String(e)}`}s=void 0,a=0,o=[],c=[]}function d(f){let p=(a===0?e():o).filter(e=>{let t=e.shortcut[a];return t!==void 0&&u(f,t)});if(p.length===0){let e=a!==0;return l(),e?d(f):void 0}s!==void 0&&clearTimeout(s),s=void 0;let m=p.find(e=>e.shortcut.length===a+1);if(m)return l(),m;let h=p[0].shortcut[a];if(c=p[0].shortcut.slice(0,a+1),a===0&&i?.onChordStart)try{i.onChordStart(n,h,r)}catch(e){`${e instanceof Error?e.message:String(e)}`}else if(a>0&&i?.onChordProgress)try{i.onChordProgress(n,c,r)}catch(e){`${e instanceof Error?e.message:String(e)}`}o=p,a+=1,s=setTimeout(()=>l(!0),t)}return{advance:d,reset:()=>l()}}function b(e={},n={}){let{chordTimeout:i=1e3,modKey:a=r(),preventDefault:o=!0,stopPropagation:s=!1,when:u,onChordState:d}=n,f=Number.isFinite(i)&&i>0?i:1e3;f!==i&&`${i}`;let p=new Map,m=new Map,h=new AbortController,g=[],_=[],b=!1;function x(){if(b)throw new t(`Keymap is disposed`)}function S(){g=[],_=[];for(let e of p.values())e.trigger===`keydown`?g.push(e):_.push(e)}function C(e){return l(c(e,a))}function w(e,t){let n=c(e,a),r=l(n);return p.set(r,{shortcut:n,...v(t)}),S(),r}function T(e){let t=p.delete(e);return t&&S(),t}function E(e){if(d)try{d(e)}catch(e){`${e instanceof Error?e.message:String(e)}`}}function D(e,t){return n=>{let r=(typeof n.composedPath==`function`?n.composedPath():[]).find(e=>m.has(e));if(r&&r!==e)return;let i=n;if(b)return;let a=t.advance(i);u&&!u(i)||!a||a.when&&!a.when(i)||(o&&i.preventDefault(),s&&i.stopPropagation(),a.handler(i))}}for(let[t,n]of Object.entries(e))w(t,n);return{bind(e,t){x();let n=w(e,t);return()=>{b||T(n)}},get disposalSignal(){return h.signal},dispose(){if(!b){b=!0,h.abort();for(let[e,t]of m)e.removeEventListener(`keydown`,t.onKeydown),e.removeEventListener(`keyup`,t.onKeyup),t.keydown.reset(),t.keyup.reset();m.clear(),p.clear(),g=[],_=[]}},get disposed(){return b},listBindings(){return[...p.values()].map(e=>({shortcut:e.shortcut.map(e=>({key:e.key,modifiers:new Set(e.modifiers)})),trigger:e.trigger}))},mount(e){x();let t=m.get(e);if(!t){let n=y(()=>g,f,e,`keydown`,{onChordProgress:(e,t,n)=>E({steps:t,target:e,trigger:n,type:`progressed`}),onChordStart:(e,t,n)=>E({step:t,target:e,trigger:n,type:`started`}),onChordTimeout:(e,t)=>E({target:e,trigger:t,type:`timeout`})}),r=y(()=>_,f,e,`keyup`,{onChordProgress:(e,t,n)=>E({steps:t,target:e,trigger:n,type:`progressed`}),onChordStart:(e,t,n)=>E({step:t,target:e,trigger:n,type:`started`}),onChordTimeout:(e,t)=>E({target:e,trigger:t,type:`timeout`})}),i=D(e,n),a=D(e,r);t={keydown:n,keyup:r,onKeydown:i,onKeyup:a,refs:0},m.set(e,t),e.addEventListener(`keydown`,i),e.addEventListener(`keyup`,a)}t.refs+=1;let n=!1;return()=>{n||(n=!0,--t.refs,!(t?.refs>0)&&(e.removeEventListener(`keydown`,t?.onKeydown),e.removeEventListener(`keyup`,t?.onKeyup),t?.keydown.reset(),t?.keyup.reset(),m.delete(e)))}},[Symbol.dispose](){this.dispose()},unbind(e){x(),T(C(e))||`${e}`}}}return e.KeymapError=t,e.KeymapParseError=n,e.canonicalizeShortcut=l,e.createKeymap=b,e.detectModKey=r,e.findShortcutConflicts=f,e.formatShortcut=_,e.matchStep=u,e.parseShortcut=c,e.parseStep=s,e})({});
|
|
2
2
|
//# sourceMappingURL=keymap.iife.js.map
|