@tanstack/angular-hotkeys 0.3.3

package/README.md

@@ -0,0 +1,122 @@
+<div align="center">
+  <img src="./media/header_hotkeys.png" alt="TanStack Hotkeys" />
+</div>
+
+<br />
+
+<div align="center">
+	<a href="https://www.npmjs.com/package/@tanstack/hotkeys" target="\_parent">
+	  <img alt="" src="https://img.shields.io/npm/dm/@tanstack/hotkeys.svg" alt="npm downloads" />
+	</a>
+	<a href="https://github.com/TanStack/hotkeys" target="\_parent">
+	  <img alt="" src="https://img.shields.io/github/stars/TanStack/hotkeys.svg?style=social&label=Star" alt="GitHub stars" />
+	</a>
+	<a href="https://bundlephobia.com/result?p=@tanstack/react-hotkeys@latest" target="\_parent">
+	  <img alt="" src="https://badgen.net/bundlephobia/minzip/@tanstack/react-hotkeys@latest" alt="Bundle size" />
+	</a>
+</div>
+
+<div align="center">
+	<a href="#badge">
+	  <img alt="semantic-release" src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg">
+	</a>
+	<a href="#badge">
+	  <img src="https://img.shields.io/github/v/release/tanstack/hotkeys" alt="Release"/>
+	</a>
+	<a href="https://twitter.com/tan_stack">
+	  <img src="https://img.shields.io/twitter/follow/tan_stack.svg?style=social" alt="Follow @TanStack"/>
+	</a>
+</div>
+
+<div align="center">
+
+### [Become a Sponsor!](https://github.com/sponsors/tannerlinsley/)
+
+</div>
+
+# TanStack Hotkeys
+
+> [!NOTE]
+> TanStack Hotkeys is pre-alpha (prototyping phase). We are actively developing the library and are open to feedback and contributions.
+
+Type-safe keyboard shortcuts for the web. Template-string bindings, parsed objects, a cross-platform `Mod` key, a singleton Hotkey Manager, and utilities for cheatsheet UIs—built to stay SSR-friendly.
+
+- Type-safe bindings — template strings (`Mod+Shift+S`, `Escape`) or parsed objects for full control
+- Flexible options — `keydown`/`keyup`, `preventDefault`, `stopPropagation`, conditional enabled, `requireReset`
+- Cross-platform Mod — maps to Cmd on macOS and Ctrl on Windows/Linux
+- Batteries included — validation + matching, sequences (Vim-style), key-state tracking, recorder UI helpers, React hooks, and devtools (in progress)
+
+### <a href="https://tanstack.com/hotkeys">Read the docs →</a>
+
+<br />
+
+> [!NOTE]
+> You may know **TanStack Hotkeys** by our adapter names, too!
+>
+> - [**React Hotkeys**](https://tanstack.com/hotkeys/latest/docs/framework/react/react-hotkeys)
+> - [**Preact Hotkeys**](https://tanstack.com/hotkeys/latest/docs/framework/preact/preact-hotkeys)
+> - [**Solid Hotkeys**](https://tanstack.com/hotkeys/latest/docs/framework/solid/reference)
+> - [**Angular Hotkeys**](https://tanstack.com/hotkeys/latest/docs/framework/angular/reference)
+> - Svelte Hotkeys – needs a contributor!
+> - Vue Hotkeys – needs a contributor!
+
+## Get Involved
+
+- We welcome issues and pull requests!
+- Participate in [GitHub discussions](https://github.com/TanStack/hotkeys/discussions)
+- Chat with the community on [Discord](https://discord.com/invite/WrRKjPJ)
+- See [CONTRIBUTING.md](./CONTRIBUTING.md) for setup instructions
+
+## Partners
+
+<div align="center">
+
+<table align="center">
+  <tr>
+    <td>
+      <a href="https://www.coderabbit.ai/?via=tanstack&dub_id=aCcEEdAOqqutX6OS" >
+        <picture>
+          <source media="(prefers-color-scheme: dark)" srcset="https://tanstack.com/assets/coderabbit-dark-D643Zkrv.svg" height="40" />
+          <source media="(prefers-color-scheme: light)" srcset="https://tanstack.com/assets/coderabbit-light-CIzGLYU_.svg" height="40" />
+          <img src="https://tanstack.com/assets/coderabbit-light-DVMJ2jHi.svg" height="40" alt="CodeRabbit" />
+        </picture>
+      </a>
+    </td>
+    <td>
+      <a href="https://www.cloudflare.com?utm_source=tanstack">
+        <picture>
+          <source media="(prefers-color-scheme: dark)" srcset="https://tanstack.com/assets/cloudflare-white-Co-Tyjbl.svg" height="60" />
+          <source media="(prefers-color-scheme: light)" srcset="https://tanstack.com/assets/cloudflare-black-6Ojsn8yh.svg" height="60" />
+          <img src="https://tanstack.com/assets/cloudflare-black-CPufaW0B.svg" height="60" alt="Cloudflare" />
+        </picture>
+      </a>
+    </td>
+  </tr>
+</table>
+
+<div align="center">
+<img src="media/partner_logo.svg" alt="Keys & you?" height="65">
+<p>
+We're looking for TanStack Hotkeys Partners to join our mission! Partner with us to push the boundaries of TanStack Hotkeys and build amazing things together.
+</p>
+<a href="mailto:partners@tanstack.com?subject=TanStack Hotkeys Partnership"><b>LET'S CHAT</b></a>
+</div>
+
+</div>
+
+## Explore the TanStack Ecosystem
+
+- <a href="https://github.com/tanstack/config"><b>TanStack Config</b></a> – Tooling for JS/TS packages
+- <a href="https://github.com/tanstack/db"><b>TanStack DB</b></a> – Reactive sync client store
+- <a href="https://github.com/tanstack/devtools"><b>TanStack DevTools</b></a> – Unified devtools panel
+- <a href="https://github.com/tanstack/form"><b>TanStack Form</b></a> – Type‑safe form state
+- <a href="https://github.com/tanstack/hotkeys"><b>TanStack Hotkeys</b></a> – Type‑safe keyboard shortcuts
+- <a href="https://github.com/tanstack/query"><b>TanStack Query</b></a> – Async state & caching
+- <a href="https://github.com/tanstack/ranger"><b>TanStack Ranger</b></a> – Range & slider primitives
+- <a href="https://github.com/tanstack/router"><b>TanStack Router</b></a> – Type‑safe routing, caching & URL state
+- <a href="https://github.com/tanstack/start"><b>TanStack Start</b></a> – Full‑stack SSR & streaming
+- <a href="https://github.com/tanstack/store"><b>TanStack Store</b></a> – Reactive data store
+- <a href="https://github.com/tanstack/table"><b>TanStack Table</b></a> – Headless datagrids
+- <a href="https://github.com/tanstack/virtual"><b>TanStack Virtual</b></a> – Virtualized rendering
+
+… and more at <a href="https://tanstack.com"><b>TanStack.com »</b></a>

package/dist/hotkeys-provider.cjs

@@ -0,0 +1,26 @@
+let _angular_core = require("@angular/core");
+
+//#region src/hotkeys-provider.ts
+const HOTKEYS_INJECTION_TOKEN = new _angular_core.InjectionToken("HOTKEYS_INJECTION_TOKEN", {
+	providedIn: "root",
+	factory: () => ({ defaultOptions: {} })
+});
+function provideHotkeys(defaultOptions) {
+	return {
+		provide: HOTKEYS_INJECTION_TOKEN,
+		useValue: { defaultOptions }
+	};
+}
+function injectHotkeysContext() {
+	return (0, _angular_core.inject)(HOTKEYS_INJECTION_TOKEN);
+}
+function injectDefaultHotkeysOptions() {
+	return injectHotkeysContext().defaultOptions;
+}
+
+//#endregion
+exports.HOTKEYS_INJECTION_TOKEN = HOTKEYS_INJECTION_TOKEN;
+exports.injectDefaultHotkeysOptions = injectDefaultHotkeysOptions;
+exports.injectHotkeysContext = injectHotkeysContext;
+exports.provideHotkeys = provideHotkeys;
+//# sourceMappingURL=hotkeys-provider.cjs.map

package/dist/hotkeys-provider.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"hotkeys-provider.cjs","names":["InjectionToken"],"sources":["../src/hotkeys-provider.ts"],"sourcesContent":["import { InjectionToken, inject } from '@angular/core'\nimport type { HotkeyRecorderOptions } from '@tanstack/hotkeys'\nimport type { InjectHotkeyOptions } from './injectHotkey'\nimport type { InjectHotkeySequenceOptions } from './injectHotkeySequence'\nimport type { StaticProvider } from '@angular/core'\n\nexport interface HotkeysProviderOptions {\n  hotkey?: Partial<InjectHotkeyOptions>\n  hotkeyRecorder?: Partial<HotkeyRecorderOptions>\n  hotkeySequence?: Partial<InjectHotkeySequenceOptions>\n}\n\nexport interface HotkeysContextValue {\n  readonly defaultOptions: HotkeysProviderOptions\n}\n\nexport const HOTKEYS_INJECTION_TOKEN = new InjectionToken<HotkeysContextValue>(\n  'HOTKEYS_INJECTION_TOKEN',\n  {\n    providedIn: 'root',\n    factory: () => ({ defaultOptions: {} }),\n  },\n)\n\nexport function provideHotkeys(\n  defaultOptions: HotkeysProviderOptions,\n): StaticProvider {\n  return {\n    provide: HOTKEYS_INJECTION_TOKEN,\n    useValue: { defaultOptions },\n  }\n}\n\nexport function injectHotkeysContext(): HotkeysContextValue {\n  return inject(HOTKEYS_INJECTION_TOKEN)\n}\n\nexport function injectDefaultHotkeysOptions(): HotkeysProviderOptions {\n  return injectHotkeysContext().defaultOptions\n}\n"],"mappings":";;;AAgBA,MAAa,0BAA0B,IAAIA,6BACzC,2BACA;CACE,YAAY;CACZ,gBAAgB,EAAE,gBAAgB,EAAE,EAAE;CACvC,CACF;AAED,SAAgB,eACd,gBACgB;AAChB,QAAO;EACL,SAAS;EACT,UAAU,EAAE,gBAAgB;EAC7B;;AAGH,SAAgB,uBAA4C;AAC1D,kCAAc,wBAAwB;;AAGxC,SAAgB,8BAAsD;AACpE,QAAO,sBAAsB,CAAC"}

package/dist/hotkeys-provider.d.cts

@@ -0,0 +1,21 @@
+import { InjectHotkeyOptions } from "./injectHotkey.cjs";
+import { InjectHotkeySequenceOptions } from "./injectHotkeySequence.cjs";
+import { HotkeyRecorderOptions } from "@tanstack/hotkeys";
+import { InjectionToken, StaticProvider } from "@angular/core";
+
+//#region src/hotkeys-provider.d.ts
+interface HotkeysProviderOptions {
+  hotkey?: Partial<InjectHotkeyOptions>;
+  hotkeyRecorder?: Partial<HotkeyRecorderOptions>;
+  hotkeySequence?: Partial<InjectHotkeySequenceOptions>;
+}
+interface HotkeysContextValue {
+  readonly defaultOptions: HotkeysProviderOptions;
+}
+declare const HOTKEYS_INJECTION_TOKEN: InjectionToken<HotkeysContextValue>;
+declare function provideHotkeys(defaultOptions: HotkeysProviderOptions): StaticProvider;
+declare function injectHotkeysContext(): HotkeysContextValue;
+declare function injectDefaultHotkeysOptions(): HotkeysProviderOptions;
+//#endregion
+export { HOTKEYS_INJECTION_TOKEN, HotkeysContextValue, HotkeysProviderOptions, injectDefaultHotkeysOptions, injectHotkeysContext, provideHotkeys };
+//# sourceMappingURL=hotkeys-provider.d.cts.map

package/dist/hotkeys-provider.d.ts

@@ -0,0 +1,21 @@
+import { InjectHotkeyOptions } from "./injectHotkey.js";
+import { InjectHotkeySequenceOptions } from "./injectHotkeySequence.js";
+import { HotkeyRecorderOptions } from "@tanstack/hotkeys";
+import { InjectionToken, StaticProvider } from "@angular/core";
+
+//#region src/hotkeys-provider.d.ts
+interface HotkeysProviderOptions {
+  hotkey?: Partial<InjectHotkeyOptions>;
+  hotkeyRecorder?: Partial<HotkeyRecorderOptions>;
+  hotkeySequence?: Partial<InjectHotkeySequenceOptions>;
+}
+interface HotkeysContextValue {
+  readonly defaultOptions: HotkeysProviderOptions;
+}
+declare const HOTKEYS_INJECTION_TOKEN: InjectionToken<HotkeysContextValue>;
+declare function provideHotkeys(defaultOptions: HotkeysProviderOptions): StaticProvider;
+declare function injectHotkeysContext(): HotkeysContextValue;
+declare function injectDefaultHotkeysOptions(): HotkeysProviderOptions;
+//#endregion
+export { HOTKEYS_INJECTION_TOKEN, HotkeysContextValue, HotkeysProviderOptions, injectDefaultHotkeysOptions, injectHotkeysContext, provideHotkeys };
+//# sourceMappingURL=hotkeys-provider.d.ts.map

package/dist/hotkeys-provider.js

@@ -0,0 +1,23 @@
+import { InjectionToken, inject } from "@angular/core";
+
+//#region src/hotkeys-provider.ts
+const HOTKEYS_INJECTION_TOKEN = new InjectionToken("HOTKEYS_INJECTION_TOKEN", {
+	providedIn: "root",
+	factory: () => ({ defaultOptions: {} })
+});
+function provideHotkeys(defaultOptions) {
+	return {
+		provide: HOTKEYS_INJECTION_TOKEN,
+		useValue: { defaultOptions }
+	};
+}
+function injectHotkeysContext() {
+	return inject(HOTKEYS_INJECTION_TOKEN);
+}
+function injectDefaultHotkeysOptions() {
+	return injectHotkeysContext().defaultOptions;
+}
+
+//#endregion
+export { HOTKEYS_INJECTION_TOKEN, injectDefaultHotkeysOptions, injectHotkeysContext, provideHotkeys };
+//# sourceMappingURL=hotkeys-provider.js.map

package/dist/hotkeys-provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hotkeys-provider.js","names":[],"sources":["../src/hotkeys-provider.ts"],"sourcesContent":["import { InjectionToken, inject } from '@angular/core'\nimport type { HotkeyRecorderOptions } from '@tanstack/hotkeys'\nimport type { InjectHotkeyOptions } from './injectHotkey'\nimport type { InjectHotkeySequenceOptions } from './injectHotkeySequence'\nimport type { StaticProvider } from '@angular/core'\n\nexport interface HotkeysProviderOptions {\n  hotkey?: Partial<InjectHotkeyOptions>\n  hotkeyRecorder?: Partial<HotkeyRecorderOptions>\n  hotkeySequence?: Partial<InjectHotkeySequenceOptions>\n}\n\nexport interface HotkeysContextValue {\n  readonly defaultOptions: HotkeysProviderOptions\n}\n\nexport const HOTKEYS_INJECTION_TOKEN = new InjectionToken<HotkeysContextValue>(\n  'HOTKEYS_INJECTION_TOKEN',\n  {\n    providedIn: 'root',\n    factory: () => ({ defaultOptions: {} }),\n  },\n)\n\nexport function provideHotkeys(\n  defaultOptions: HotkeysProviderOptions,\n): StaticProvider {\n  return {\n    provide: HOTKEYS_INJECTION_TOKEN,\n    useValue: { defaultOptions },\n  }\n}\n\nexport function injectHotkeysContext(): HotkeysContextValue {\n  return inject(HOTKEYS_INJECTION_TOKEN)\n}\n\nexport function injectDefaultHotkeysOptions(): HotkeysProviderOptions {\n  return injectHotkeysContext().defaultOptions\n}\n"],"mappings":";;;AAgBA,MAAa,0BAA0B,IAAI,eACzC,2BACA;CACE,YAAY;CACZ,gBAAgB,EAAE,gBAAgB,EAAE,EAAE;CACvC,CACF;AAED,SAAgB,eACd,gBACgB;AAChB,QAAO;EACL,SAAS;EACT,UAAU,EAAE,gBAAgB;EAC7B;;AAGH,SAAgB,uBAA4C;AAC1D,QAAO,OAAO,wBAAwB;;AAGxC,SAAgB,8BAAsD;AACpE,QAAO,sBAAsB,CAAC"}

package/dist/index.cjs

@@ -0,0 +1,26 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+const require_hotkeys_provider = require('./hotkeys-provider.cjs');
+const require_injectHotkey = require('./injectHotkey.cjs');
+const require_injectHotkeySequence = require('./injectHotkeySequence.cjs');
+const require_injectHeldKeys = require('./injectHeldKeys.cjs');
+const require_injectHeldKeyCodes = require('./injectHeldKeyCodes.cjs');
+const require_injectKeyHold = require('./injectKeyHold.cjs');
+const require_injectHotkeyRecorder = require('./injectHotkeyRecorder.cjs');
+
+exports.HOTKEYS_INJECTION_TOKEN = require_hotkeys_provider.HOTKEYS_INJECTION_TOKEN;
+exports.injectDefaultHotkeysOptions = require_hotkeys_provider.injectDefaultHotkeysOptions;
+exports.injectHeldKeyCodes = require_injectHeldKeyCodes.injectHeldKeyCodes;
+exports.injectHeldKeys = require_injectHeldKeys.injectHeldKeys;
+exports.injectHotkey = require_injectHotkey.injectHotkey;
+exports.injectHotkeyRecorder = require_injectHotkeyRecorder.injectHotkeyRecorder;
+exports.injectHotkeySequence = require_injectHotkeySequence.injectHotkeySequence;
+exports.injectHotkeysContext = require_hotkeys_provider.injectHotkeysContext;
+exports.injectKeyHold = require_injectKeyHold.injectKeyHold;
+exports.provideHotkeys = require_hotkeys_provider.provideHotkeys;
+var _tanstack_hotkeys = require("@tanstack/hotkeys");
+Object.keys(_tanstack_hotkeys).forEach(function (k) {
+  if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+    enumerable: true,
+    get: function () { return _tanstack_hotkeys[k]; }
+  });
+});

package/dist/index.d.cts

@@ -0,0 +1,9 @@
+import { InjectHotkeyOptions, injectHotkey } from "./injectHotkey.cjs";
+import { InjectHotkeySequenceOptions, injectHotkeySequence } from "./injectHotkeySequence.cjs";
+import { HOTKEYS_INJECTION_TOKEN, HotkeysContextValue, HotkeysProviderOptions, injectDefaultHotkeysOptions, injectHotkeysContext, provideHotkeys } from "./hotkeys-provider.cjs";
+import { injectHeldKeys } from "./injectHeldKeys.cjs";
+import { injectHeldKeyCodes } from "./injectHeldKeyCodes.cjs";
+import { injectKeyHold } from "./injectKeyHold.cjs";
+import { AngularHotkeyRecorder, injectHotkeyRecorder } from "./injectHotkeyRecorder.cjs";
+export * from "@tanstack/hotkeys";
+export { AngularHotkeyRecorder, HOTKEYS_INJECTION_TOKEN, HotkeysContextValue, HotkeysProviderOptions, InjectHotkeyOptions, InjectHotkeySequenceOptions, injectDefaultHotkeysOptions, injectHeldKeyCodes, injectHeldKeys, injectHotkey, injectHotkeyRecorder, injectHotkeySequence, injectHotkeysContext, injectKeyHold, provideHotkeys };

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+import { InjectHotkeyOptions, injectHotkey } from "./injectHotkey.js";
+import { InjectHotkeySequenceOptions, injectHotkeySequence } from "./injectHotkeySequence.js";
+import { HOTKEYS_INJECTION_TOKEN, HotkeysContextValue, HotkeysProviderOptions, injectDefaultHotkeysOptions, injectHotkeysContext, provideHotkeys } from "./hotkeys-provider.js";
+import { injectHeldKeys } from "./injectHeldKeys.js";
+import { injectHeldKeyCodes } from "./injectHeldKeyCodes.js";
+import { injectKeyHold } from "./injectKeyHold.js";
+import { AngularHotkeyRecorder, injectHotkeyRecorder } from "./injectHotkeyRecorder.js";
+export * from "@tanstack/hotkeys";
+export { AngularHotkeyRecorder, HOTKEYS_INJECTION_TOKEN, HotkeysContextValue, HotkeysProviderOptions, InjectHotkeyOptions, InjectHotkeySequenceOptions, injectDefaultHotkeysOptions, injectHeldKeyCodes, injectHeldKeys, injectHotkey, injectHotkeyRecorder, injectHotkeySequence, injectHotkeysContext, injectKeyHold, provideHotkeys };

package/dist/index.js

@@ -0,0 +1,11 @@
+import { HOTKEYS_INJECTION_TOKEN, injectDefaultHotkeysOptions, injectHotkeysContext, provideHotkeys } from "./hotkeys-provider.js";
+import { injectHotkey } from "./injectHotkey.js";
+import { injectHotkeySequence } from "./injectHotkeySequence.js";
+import { injectHeldKeys } from "./injectHeldKeys.js";
+import { injectHeldKeyCodes } from "./injectHeldKeyCodes.js";
+import { injectKeyHold } from "./injectKeyHold.js";
+import { injectHotkeyRecorder } from "./injectHotkeyRecorder.js";
+
+export * from "@tanstack/hotkeys"
+
+export { HOTKEYS_INJECTION_TOKEN, injectDefaultHotkeysOptions, injectHeldKeyCodes, injectHeldKeys, injectHotkey, injectHotkeyRecorder, injectHotkeySequence, injectHotkeysContext, injectKeyHold, provideHotkeys };

package/dist/injectHeldKeyCodes.cjs

@@ -0,0 +1,34 @@
+let _tanstack_hotkeys = require("@tanstack/hotkeys");
+let _tanstack_angular_store = require("@tanstack/angular-store");
+
+//#region src/injectHeldKeyCodes.ts
+/**
+* Angular inject-based API that returns a signal of a map from held key names to their physical `event.code` values.
+*
+* Useful for debugging which physical key was pressed (e.g. distinguishing
+* left vs right Shift via "ShiftLeft" / "ShiftRight").
+*
+* @returns Signal of record mapping normalized key names to their `event.code` values
+*
+* @example
+* ```ts
+* @Component({
+*   template: `
+*     @for (key of heldKeys(); track key) {
+*       <kbd>{{ key }} <small>{{ heldCodes()[key] }}</small></kbd>
+*     }
+*   `,
+* })
+* export class KeyDebugComponent {
+*   heldKeys = injectHeldKeys()
+*   heldCodes = injectHeldKeyCodes()
+* }
+* ```
+*/
+function injectHeldKeyCodes() {
+	return (0, _tanstack_angular_store.injectStore)((0, _tanstack_hotkeys.getKeyStateTracker)().store, (state) => state.heldCodes);
+}
+
+//#endregion
+exports.injectHeldKeyCodes = injectHeldKeyCodes;
+//# sourceMappingURL=injectHeldKeyCodes.cjs.map

package/dist/injectHeldKeyCodes.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"injectHeldKeyCodes.cjs","names":[],"sources":["../src/injectHeldKeyCodes.ts"],"sourcesContent":["import { getKeyStateTracker } from '@tanstack/hotkeys'\nimport { injectStore } from '@tanstack/angular-store'\nimport type { Signal } from '@angular/core'\n\n/**\n * Angular inject-based API that returns a signal of a map from held key names to their physical `event.code` values.\n *\n * Useful for debugging which physical key was pressed (e.g. distinguishing\n * left vs right Shift via \"ShiftLeft\" / \"ShiftRight\").\n *\n * @returns Signal of record mapping normalized key names to their `event.code` values\n *\n * @example\n * ```ts\n * @Component({\n *   template: `\n *     @for (key of heldKeys(); track key) {\n *       <kbd>{{ key }} <small>{{ heldCodes()[key] }}</small></kbd>\n *     }\n *   `,\n * })\n * export class KeyDebugComponent {\n *   heldKeys = injectHeldKeys()\n *   heldCodes = injectHeldKeyCodes()\n * }\n * ```\n */\nexport function injectHeldKeyCodes(): Signal<Record<string, string>> {\n  const tracker = getKeyStateTracker()\n  return injectStore(tracker.store, (state) => state.heldCodes)\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AA2BA,SAAgB,qBAAqD;AAEnE,4FADoC,CACT,QAAQ,UAAU,MAAM,UAAU"}

package/dist/injectHeldKeyCodes.d.cts

@@ -0,0 +1,30 @@
+import { Signal } from "@angular/core";
+
+//#region src/injectHeldKeyCodes.d.ts
+/**
+ * Angular inject-based API that returns a signal of a map from held key names to their physical `event.code` values.
+ *
+ * Useful for debugging which physical key was pressed (e.g. distinguishing
+ * left vs right Shift via "ShiftLeft" / "ShiftRight").
+ *
+ * @returns Signal of record mapping normalized key names to their `event.code` values
+ *
+ * @example
+ * ```ts
+ * @Component({
+ *   template: `
+ *     @for (key of heldKeys(); track key) {
+ *       <kbd>{{ key }} <small>{{ heldCodes()[key] }}</small></kbd>
+ *     }
+ *   `,
+ * })
+ * export class KeyDebugComponent {
+ *   heldKeys = injectHeldKeys()
+ *   heldCodes = injectHeldKeyCodes()
+ * }
+ * ```
+ */
+declare function injectHeldKeyCodes(): Signal<Record<string, string>>;
+//#endregion
+export { injectHeldKeyCodes };
+//# sourceMappingURL=injectHeldKeyCodes.d.cts.map

package/dist/injectHeldKeyCodes.d.ts

@@ -0,0 +1,30 @@
+import { Signal } from "@angular/core";
+
+//#region src/injectHeldKeyCodes.d.ts
+/**
+ * Angular inject-based API that returns a signal of a map from held key names to their physical `event.code` values.
+ *
+ * Useful for debugging which physical key was pressed (e.g. distinguishing
+ * left vs right Shift via "ShiftLeft" / "ShiftRight").
+ *
+ * @returns Signal of record mapping normalized key names to their `event.code` values
+ *
+ * @example
+ * ```ts
+ * @Component({
+ *   template: `
+ *     @for (key of heldKeys(); track key) {
+ *       <kbd>{{ key }} <small>{{ heldCodes()[key] }}</small></kbd>
+ *     }
+ *   `,
+ * })
+ * export class KeyDebugComponent {
+ *   heldKeys = injectHeldKeys()
+ *   heldCodes = injectHeldKeyCodes()
+ * }
+ * ```
+ */
+declare function injectHeldKeyCodes(): Signal<Record<string, string>>;
+//#endregion
+export { injectHeldKeyCodes };
+//# sourceMappingURL=injectHeldKeyCodes.d.ts.map

package/dist/injectHeldKeyCodes.js

@@ -0,0 +1,34 @@
+import { getKeyStateTracker } from "@tanstack/hotkeys";
+import { injectStore } from "@tanstack/angular-store";
+
+//#region src/injectHeldKeyCodes.ts
+/**
+* Angular inject-based API that returns a signal of a map from held key names to their physical `event.code` values.
+*
+* Useful for debugging which physical key was pressed (e.g. distinguishing
+* left vs right Shift via "ShiftLeft" / "ShiftRight").
+*
+* @returns Signal of record mapping normalized key names to their `event.code` values
+*
+* @example
+* ```ts
+* @Component({
+*   template: `
+*     @for (key of heldKeys(); track key) {
+*       <kbd>{{ key }} <small>{{ heldCodes()[key] }}</small></kbd>
+*     }
+*   `,
+* })
+* export class KeyDebugComponent {
+*   heldKeys = injectHeldKeys()
+*   heldCodes = injectHeldKeyCodes()
+* }
+* ```
+*/
+function injectHeldKeyCodes() {
+	return injectStore(getKeyStateTracker().store, (state) => state.heldCodes);
+}
+
+//#endregion
+export { injectHeldKeyCodes };
+//# sourceMappingURL=injectHeldKeyCodes.js.map

package/dist/injectHeldKeyCodes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"injectHeldKeyCodes.js","names":[],"sources":["../src/injectHeldKeyCodes.ts"],"sourcesContent":["import { getKeyStateTracker } from '@tanstack/hotkeys'\nimport { injectStore } from '@tanstack/angular-store'\nimport type { Signal } from '@angular/core'\n\n/**\n * Angular inject-based API that returns a signal of a map from held key names to their physical `event.code` values.\n *\n * Useful for debugging which physical key was pressed (e.g. distinguishing\n * left vs right Shift via \"ShiftLeft\" / \"ShiftRight\").\n *\n * @returns Signal of record mapping normalized key names to their `event.code` values\n *\n * @example\n * ```ts\n * @Component({\n *   template: `\n *     @for (key of heldKeys(); track key) {\n *       <kbd>{{ key }} <small>{{ heldCodes()[key] }}</small></kbd>\n *     }\n *   `,\n * })\n * export class KeyDebugComponent {\n *   heldKeys = injectHeldKeys()\n *   heldCodes = injectHeldKeyCodes()\n * }\n * ```\n */\nexport function injectHeldKeyCodes(): Signal<Record<string, string>> {\n  const tracker = getKeyStateTracker()\n  return injectStore(tracker.store, (state) => state.heldCodes)\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AA2BA,SAAgB,qBAAqD;AAEnE,QAAO,YADS,oBAAoB,CACT,QAAQ,UAAU,MAAM,UAAU"}

package/dist/injectHeldKeys.cjs

@@ -0,0 +1,29 @@
+let _tanstack_hotkeys = require("@tanstack/hotkeys");
+let _tanstack_angular_store = require("@tanstack/angular-store");
+
+//#region src/injectHeldKeys.ts
+/**
+* Angular inject-based API that returns a signal of currently held keyboard keys.
+*
+* Subscribes to the global KeyStateTracker and updates whenever keys are
+* pressed or released.
+*
+* @returns Signal of array of currently held key names
+*
+* @example
+* ```ts
+* @Component({
+*   template: `<div>Currently pressed: {{ heldKeys().join(' + ') || 'None' }}</div>`,
+* })
+* export class KeyDisplayComponent {
+*   heldKeys = injectHeldKeys()
+* }
+* ```
+*/
+function injectHeldKeys() {
+	return (0, _tanstack_angular_store.injectStore)((0, _tanstack_hotkeys.getKeyStateTracker)().store, (state) => state.heldKeys);
+}
+
+//#endregion
+exports.injectHeldKeys = injectHeldKeys;
+//# sourceMappingURL=injectHeldKeys.cjs.map

package/dist/injectHeldKeys.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"injectHeldKeys.cjs","names":[],"sources":["../src/injectHeldKeys.ts"],"sourcesContent":["import { getKeyStateTracker } from '@tanstack/hotkeys'\nimport { injectStore } from '@tanstack/angular-store'\nimport type { Signal } from '@angular/core'\n\n/**\n * Angular inject-based API that returns a signal of currently held keyboard keys.\n *\n * Subscribes to the global KeyStateTracker and updates whenever keys are\n * pressed or released.\n *\n * @returns Signal of array of currently held key names\n *\n * @example\n * ```ts\n * @Component({\n *   template: `<div>Currently pressed: {{ heldKeys().join(' + ') || 'None' }}</div>`,\n * })\n * export class KeyDisplayComponent {\n *   heldKeys = injectHeldKeys()\n * }\n * ```\n */\nexport function injectHeldKeys(): Signal<Array<string>> {\n  const tracker = getKeyStateTracker()\n  return injectStore(tracker.store, (state) => state.heldKeys)\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAsBA,SAAgB,iBAAwC;AAEtD,4FADoC,CACT,QAAQ,UAAU,MAAM,SAAS"}

package/dist/injectHeldKeys.d.cts

@@ -0,0 +1,25 @@
+import { Signal } from "@angular/core";
+
+//#region src/injectHeldKeys.d.ts
+/**
+ * Angular inject-based API that returns a signal of currently held keyboard keys.
+ *
+ * Subscribes to the global KeyStateTracker and updates whenever keys are
+ * pressed or released.
+ *
+ * @returns Signal of array of currently held key names
+ *
+ * @example
+ * ```ts
+ * @Component({
+ *   template: `<div>Currently pressed: {{ heldKeys().join(' + ') || 'None' }}</div>`,
+ * })
+ * export class KeyDisplayComponent {
+ *   heldKeys = injectHeldKeys()
+ * }
+ * ```
+ */
+declare function injectHeldKeys(): Signal<Array<string>>;
+//#endregion
+export { injectHeldKeys };
+//# sourceMappingURL=injectHeldKeys.d.cts.map

package/dist/injectHeldKeys.d.ts

@@ -0,0 +1,25 @@
+import { Signal } from "@angular/core";
+
+//#region src/injectHeldKeys.d.ts
+/**
+ * Angular inject-based API that returns a signal of currently held keyboard keys.
+ *
+ * Subscribes to the global KeyStateTracker and updates whenever keys are
+ * pressed or released.
+ *
+ * @returns Signal of array of currently held key names
+ *
+ * @example
+ * ```ts
+ * @Component({
+ *   template: `<div>Currently pressed: {{ heldKeys().join(' + ') || 'None' }}</div>`,
+ * })
+ * export class KeyDisplayComponent {
+ *   heldKeys = injectHeldKeys()
+ * }
+ * ```
+ */
+declare function injectHeldKeys(): Signal<Array<string>>;
+//#endregion
+export { injectHeldKeys };
+//# sourceMappingURL=injectHeldKeys.d.ts.map

package/dist/injectHeldKeys.js

@@ -0,0 +1,29 @@
+import { getKeyStateTracker } from "@tanstack/hotkeys";
+import { injectStore } from "@tanstack/angular-store";
+
+//#region src/injectHeldKeys.ts
+/**
+* Angular inject-based API that returns a signal of currently held keyboard keys.
+*
+* Subscribes to the global KeyStateTracker and updates whenever keys are
+* pressed or released.
+*
+* @returns Signal of array of currently held key names
+*
+* @example
+* ```ts
+* @Component({
+*   template: `<div>Currently pressed: {{ heldKeys().join(' + ') || 'None' }}</div>`,
+* })
+* export class KeyDisplayComponent {
+*   heldKeys = injectHeldKeys()
+* }
+* ```
+*/
+function injectHeldKeys() {
+	return injectStore(getKeyStateTracker().store, (state) => state.heldKeys);
+}
+
+//#endregion
+export { injectHeldKeys };
+//# sourceMappingURL=injectHeldKeys.js.map

package/dist/injectHeldKeys.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"injectHeldKeys.js","names":[],"sources":["../src/injectHeldKeys.ts"],"sourcesContent":["import { getKeyStateTracker } from '@tanstack/hotkeys'\nimport { injectStore } from '@tanstack/angular-store'\nimport type { Signal } from '@angular/core'\n\n/**\n * Angular inject-based API that returns a signal of currently held keyboard keys.\n *\n * Subscribes to the global KeyStateTracker and updates whenever keys are\n * pressed or released.\n *\n * @returns Signal of array of currently held key names\n *\n * @example\n * ```ts\n * @Component({\n *   template: `<div>Currently pressed: {{ heldKeys().join(' + ') || 'None' }}</div>`,\n * })\n * export class KeyDisplayComponent {\n *   heldKeys = injectHeldKeys()\n * }\n * ```\n */\nexport function injectHeldKeys(): Signal<Array<string>> {\n  const tracker = getKeyStateTracker()\n  return injectStore(tracker.store, (state) => state.heldKeys)\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAsBA,SAAgB,iBAAwC;AAEtD,QAAO,YADS,oBAAoB,CACT,QAAQ,UAAU,MAAM,SAAS"}

package/dist/injectHotkey.cjs

@@ -0,0 +1,93 @@
+const require_hotkeys_provider = require('./hotkeys-provider.cjs');
+let _tanstack_hotkeys = require("@tanstack/hotkeys");
+let _angular_core = require("@angular/core");
+
+//#region src/injectHotkey.ts
+/**
+* Angular inject-based API for registering a keyboard hotkey.
+*
+* Uses the singleton HotkeyManager for efficient event handling.
+* The callback receives both the keyboard event and a context object
+* containing the hotkey string and parsed hotkey.
+*
+* Call in an injection context (e.g. constructor or field initializer).
+* Uses effect() to track reactive dependencies and update registration
+* when options or the callback change.
+*
+* @param hotkey - The hotkey string (e.g. 'Mod+S', 'Escape') or getter function
+* @param callback - The function to call when the hotkey is pressed
+* @param options - Options for the hotkey behavior, or getter for reactive options
+*
+* @example
+* ```ts
+* @Component({ ... })
+* export class SaveButtonComponent {
+*   private readonly saveCount = signal(0)
+*
+*   constructor() {
+*     injectHotkey('Mod+S', (event, { hotkey }) => {
+*       event.preventDefault()
+*       this.saveCount.update(c => c + 1)
+*     })
+*   }
+* }
+* ```
+*
+* @example
+* ```ts
+* @Component({ ... })
+* export class ModalComponent {
+*   isOpen = signal(true)
+*
+*   constructor() {
+*     injectHotkey('Escape', () => this.close(), () => ({ enabled: this.isOpen() }))
+*   }
+* }
+* ```
+*
+* @example
+* ```ts
+* @Component({ ... })
+* export class EditorComponent {
+*   private readonly editorRef = viewChild<ElementRef<HTMLDivElement>>('editorRef')
+*
+*   constructor() {
+*     injectHotkey('Mod+B', () => this.toggleBold(), () => ({
+*       target: this.editorRef()?.nativeElement ?? null,
+*     }))
+*   }
+* }
+* ```
+*/
+function injectHotkey(hotkey, callback, options = {}) {
+	const defaultOptions = require_hotkeys_provider.injectDefaultHotkeysOptions();
+	const manager = (0, _tanstack_hotkeys.getHotkeyManager)();
+	(0, _angular_core.effect)((onCleanup) => {
+		const resolvedHotkey = typeof hotkey === "function" ? hotkey() : hotkey;
+		const resolvedOptions = typeof options === "function" ? options() : options;
+		const mergedOptions = {
+			...defaultOptions.hotkey,
+			...resolvedOptions
+		};
+		const platform = mergedOptions.platform ?? (0, _tanstack_hotkeys.detectPlatform)();
+		const hotkeyString = typeof resolvedHotkey === "string" ? resolvedHotkey : (0, _tanstack_hotkeys.formatHotkey)((0, _tanstack_hotkeys.rawHotkeyToParsedHotkey)(resolvedHotkey, platform));
+		const resolvedTarget = "target" in mergedOptions ? mergedOptions.target ?? null : typeof document !== "undefined" ? document : null;
+		if (!resolvedTarget) return;
+		const { target: _target, ...optionsWithoutTarget } = mergedOptions;
+		const registration = manager.register(hotkeyString, callback, {
+			...optionsWithoutTarget,
+			target: resolvedTarget
+		});
+		if (registration.isActive) {
+			registration.callback = callback;
+			registration.setOptions(optionsWithoutTarget);
+		}
+		onCleanup(() => {
+			if (registration.isActive) registration.unregister();
+		});
+	});
+}
+
+//#endregion
+exports.injectHotkey = injectHotkey;
+//# sourceMappingURL=injectHotkey.cjs.map