@tanstack/angular-hotkeys 0.8.3 → 0.9.0

package/README.md

@@ -58,6 +58,7 @@ Type-safe keyboard shortcuts for the web. Template-string bindings, parsed objec
 > - [**Solid Hotkeys**](https://tanstack.com/hotkeys/latest/docs/framework/solid/reference)
 > - [**Angular Hotkeys**](https://tanstack.com/hotkeys/latest/docs/framework/angular/reference)
 > - [**Vue Hotkeys**](https://tanstack.com/hotkeys/latest/docs/framework/vue/reference)
+> - [**Lit Hotkeys**](https://tanstack.com/hotkeys/latest/docs/framework/lit/reference)
 > - [**Svelte Hotkeys**](https://tanstack.com/hotkeys/latest/docs/framework/svelte/reference)
 
 ## Get Involved

package/dist/index.cjs

@@ -8,6 +8,7 @@ const require_injectHeldKeys = require('./injectHeldKeys.cjs');
 const require_injectHeldKeyCodes = require('./injectHeldKeyCodes.cjs');
 const require_injectKeyHold = require('./injectKeyHold.cjs');
 const require_injectHotkeyRecorder = require('./injectHotkeyRecorder.cjs');
+const require_injectHotkeyRegistrations = require('./injectHotkeyRegistrations.cjs');
 const require_injectHotkeySequenceRecorder = require('./injectHotkeySequenceRecorder.cjs');
 
 exports.HOTKEYS_INJECTION_TOKEN = require_hotkeys_provider.HOTKEYS_INJECTION_TOKEN;
@@ -16,6 +17,7 @@ exports.injectHeldKeyCodes = require_injectHeldKeyCodes.injectHeldKeyCodes;
 exports.injectHeldKeys = require_injectHeldKeys.injectHeldKeys;
 exports.injectHotkey = require_injectHotkey.injectHotkey;
 exports.injectHotkeyRecorder = require_injectHotkeyRecorder.injectHotkeyRecorder;
+exports.injectHotkeyRegistrations = require_injectHotkeyRegistrations.injectHotkeyRegistrations;
 exports.injectHotkeySequence = require_injectHotkeySequence.injectHotkeySequence;
 exports.injectHotkeySequenceRecorder = require_injectHotkeySequenceRecorder.injectHotkeySequenceRecorder;
 exports.injectHotkeySequences = require_injectHotkeySequences.injectHotkeySequences;

package/dist/index.d.cts

@@ -7,6 +7,7 @@ import { injectHeldKeys } from "./injectHeldKeys.cjs";
 import { injectHeldKeyCodes } from "./injectHeldKeyCodes.cjs";
 import { injectKeyHold } from "./injectKeyHold.cjs";
 import { AngularHotkeyRecorder, injectHotkeyRecorder } from "./injectHotkeyRecorder.cjs";
+import { HotkeyRegistrationsResult, injectHotkeyRegistrations } from "./injectHotkeyRegistrations.cjs";
 import { AngularHotkeySequenceRecorder, injectHotkeySequenceRecorder } from "./injectHotkeySequenceRecorder.cjs";
 export * from "@tanstack/hotkeys";
-export { AngularHotkeyRecorder, AngularHotkeySequenceRecorder, HOTKEYS_INJECTION_TOKEN, HotkeysContextValue, HotkeysProviderOptions, InjectHotkeyDefinition, InjectHotkeyOptions, InjectHotkeySequenceDefinition, InjectHotkeySequenceOptions, injectDefaultHotkeysOptions, injectHeldKeyCodes, injectHeldKeys, injectHotkey, injectHotkeyRecorder, injectHotkeySequence, injectHotkeySequenceRecorder, injectHotkeySequences, injectHotkeys, injectHotkeysContext, injectKeyHold, provideHotkeys };
+export { AngularHotkeyRecorder, AngularHotkeySequenceRecorder, HOTKEYS_INJECTION_TOKEN, HotkeyRegistrationsResult, HotkeysContextValue, HotkeysProviderOptions, InjectHotkeyDefinition, InjectHotkeyOptions, InjectHotkeySequenceDefinition, InjectHotkeySequenceOptions, injectDefaultHotkeysOptions, injectHeldKeyCodes, injectHeldKeys, injectHotkey, injectHotkeyRecorder, injectHotkeyRegistrations, injectHotkeySequence, injectHotkeySequenceRecorder, injectHotkeySequences, injectHotkeys, injectHotkeysContext, injectKeyHold, provideHotkeys };

package/dist/index.d.ts

@@ -7,6 +7,7 @@ import { injectHeldKeys } from "./injectHeldKeys.js";
 import { injectHeldKeyCodes } from "./injectHeldKeyCodes.js";
 import { injectKeyHold } from "./injectKeyHold.js";
 import { AngularHotkeyRecorder, injectHotkeyRecorder } from "./injectHotkeyRecorder.js";
+import { HotkeyRegistrationsResult, injectHotkeyRegistrations } from "./injectHotkeyRegistrations.js";
 import { AngularHotkeySequenceRecorder, injectHotkeySequenceRecorder } from "./injectHotkeySequenceRecorder.js";
 export * from "@tanstack/hotkeys";
-export { AngularHotkeyRecorder, AngularHotkeySequenceRecorder, HOTKEYS_INJECTION_TOKEN, HotkeysContextValue, HotkeysProviderOptions, InjectHotkeyDefinition, InjectHotkeyOptions, InjectHotkeySequenceDefinition, InjectHotkeySequenceOptions, injectDefaultHotkeysOptions, injectHeldKeyCodes, injectHeldKeys, injectHotkey, injectHotkeyRecorder, injectHotkeySequence, injectHotkeySequenceRecorder, injectHotkeySequences, injectHotkeys, injectHotkeysContext, injectKeyHold, provideHotkeys };
+export { AngularHotkeyRecorder, AngularHotkeySequenceRecorder, HOTKEYS_INJECTION_TOKEN, HotkeyRegistrationsResult, HotkeysContextValue, HotkeysProviderOptions, InjectHotkeyDefinition, InjectHotkeyOptions, InjectHotkeySequenceDefinition, InjectHotkeySequenceOptions, injectDefaultHotkeysOptions, injectHeldKeyCodes, injectHeldKeys, injectHotkey, injectHotkeyRecorder, injectHotkeyRegistrations, injectHotkeySequence, injectHotkeySequenceRecorder, injectHotkeySequences, injectHotkeys, injectHotkeysContext, injectKeyHold, provideHotkeys };

package/dist/index.js

@@ -7,8 +7,9 @@ import { injectHeldKeys } from "./injectHeldKeys.js";
 import { injectHeldKeyCodes } from "./injectHeldKeyCodes.js";
 import { injectKeyHold } from "./injectKeyHold.js";
 import { injectHotkeyRecorder } from "./injectHotkeyRecorder.js";
+import { injectHotkeyRegistrations } from "./injectHotkeyRegistrations.js";
 import { injectHotkeySequenceRecorder } from "./injectHotkeySequenceRecorder.js";
 
 export * from "@tanstack/hotkeys"
 
-export { HOTKEYS_INJECTION_TOKEN, injectDefaultHotkeysOptions, injectHeldKeyCodes, injectHeldKeys, injectHotkey, injectHotkeyRecorder, injectHotkeySequence, injectHotkeySequenceRecorder, injectHotkeySequences, injectHotkeys, injectHotkeysContext, injectKeyHold, provideHotkeys };
+export { HOTKEYS_INJECTION_TOKEN, injectDefaultHotkeysOptions, injectHeldKeyCodes, injectHeldKeys, injectHotkey, injectHotkeyRecorder, injectHotkeyRegistrations, injectHotkeySequence, injectHotkeySequenceRecorder, injectHotkeySequences, injectHotkeys, injectHotkeysContext, injectKeyHold, provideHotkeys };

package/dist/injectHotkeyRegistrations.cjs

@@ -0,0 +1,28 @@
+let _tanstack_hotkeys = require("@tanstack/hotkeys");
+let _tanstack_angular_store = require("@tanstack/angular-store");
+
+//#region src/injectHotkeyRegistrations.ts
+/**
+* Angular injectable that reactively reads all hotkey and sequence registrations
+* from the singleton managers.
+*
+* This is a standalone injectable that does NOT require the HotkeysProvider.
+* It subscribes to both HotkeyManager and SequenceManager stores and
+* triggers change detection when registrations change.
+*
+* Must be called in an injection context (constructor, factory, or `inject()`).
+*
+* @returns Object with `hotkeys` and `sequences` signals
+*/
+function injectHotkeyRegistrations() {
+	const hotkeyManager = (0, _tanstack_hotkeys.getHotkeyManager)();
+	const sequenceManager = (0, _tanstack_hotkeys.getSequenceManager)();
+	return {
+		hotkeys: (0, _tanstack_angular_store.injectStore)(hotkeyManager.registrations, (state) => Array.from(state.values()).map(_tanstack_hotkeys.toHotkeyRegistrationView)),
+		sequences: (0, _tanstack_angular_store.injectStore)(sequenceManager.registrations, (state) => Array.from(state.values()))
+	};
+}
+
+//#endregion
+exports.injectHotkeyRegistrations = injectHotkeyRegistrations;
+//# sourceMappingURL=injectHotkeyRegistrations.cjs.map

package/dist/injectHotkeyRegistrations.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"injectHotkeyRegistrations.cjs","names":["toHotkeyRegistrationView"],"sources":["../src/injectHotkeyRegistrations.ts"],"sourcesContent":["import { injectStore } from '@tanstack/angular-store'\nimport {\n  getHotkeyManager,\n  getSequenceManager,\n  toHotkeyRegistrationView,\n} from '@tanstack/hotkeys'\nimport type {\n  HotkeyRegistrationView,\n  SequenceRegistrationView,\n} from '@tanstack/hotkeys'\nimport type { Signal } from '@angular/core'\n\n/**\n * Return type for injectHotkeyRegistrations.\n */\nexport interface HotkeyRegistrationsResult {\n  /** Signal for all registered hotkeys (public view, no callbacks) */\n  hotkeys: Signal<Array<HotkeyRegistrationView>>\n  /** Signal for all registered sequences */\n  sequences: Signal<Array<SequenceRegistrationView>>\n}\n\n/**\n * Angular injectable that reactively reads all hotkey and sequence registrations\n * from the singleton managers.\n *\n * This is a standalone injectable that does NOT require the HotkeysProvider.\n * It subscribes to both HotkeyManager and SequenceManager stores and\n * triggers change detection when registrations change.\n *\n * Must be called in an injection context (constructor, factory, or `inject()`).\n *\n * @returns Object with `hotkeys` and `sequences` signals\n */\nexport function injectHotkeyRegistrations(): HotkeyRegistrationsResult {\n  const hotkeyManager = getHotkeyManager()\n  const sequenceManager = getSequenceManager()\n\n  const hotkeys = injectStore(hotkeyManager.registrations, (state) =>\n    Array.from(state.values()).map(toHotkeyRegistrationView),\n  )\n\n  const sequences = injectStore(sequenceManager.registrations, (state) =>\n    Array.from(state.values()),\n  )\n\n  return { hotkeys, sequences }\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAkCA,SAAgB,4BAAuD;CACrE,MAAM,yDAAkC;CACxC,MAAM,6DAAsC;AAU5C,QAAO;EAAE,kDARmB,cAAc,gBAAgB,UACxD,MAAM,KAAK,MAAM,QAAQ,CAAC,CAAC,IAAIA,2CAAyB,CACzD;EAMiB,oDAJY,gBAAgB,gBAAgB,UAC5D,MAAM,KAAK,MAAM,QAAQ,CAAC,CAC3B;EAE4B"}

package/dist/injectHotkeyRegistrations.d.cts

@@ -0,0 +1,29 @@
+import { HotkeyRegistrationView, SequenceRegistrationView } from "@tanstack/hotkeys";
+import { Signal } from "@angular/core";
+
+//#region src/injectHotkeyRegistrations.d.ts
+/**
+ * Return type for injectHotkeyRegistrations.
+ */
+interface HotkeyRegistrationsResult {
+  /** Signal for all registered hotkeys (public view, no callbacks) */
+  hotkeys: Signal<Array<HotkeyRegistrationView>>;
+  /** Signal for all registered sequences */
+  sequences: Signal<Array<SequenceRegistrationView>>;
+}
+/**
+ * Angular injectable that reactively reads all hotkey and sequence registrations
+ * from the singleton managers.
+ *
+ * This is a standalone injectable that does NOT require the HotkeysProvider.
+ * It subscribes to both HotkeyManager and SequenceManager stores and
+ * triggers change detection when registrations change.
+ *
+ * Must be called in an injection context (constructor, factory, or `inject()`).
+ *
+ * @returns Object with `hotkeys` and `sequences` signals
+ */
+declare function injectHotkeyRegistrations(): HotkeyRegistrationsResult;
+//#endregion
+export { HotkeyRegistrationsResult, injectHotkeyRegistrations };
+//# sourceMappingURL=injectHotkeyRegistrations.d.cts.map

package/dist/injectHotkeyRegistrations.d.ts

@@ -0,0 +1,29 @@
+import { HotkeyRegistrationView, SequenceRegistrationView } from "@tanstack/hotkeys";
+import { Signal } from "@angular/core";
+
+//#region src/injectHotkeyRegistrations.d.ts
+/**
+ * Return type for injectHotkeyRegistrations.
+ */
+interface HotkeyRegistrationsResult {
+  /** Signal for all registered hotkeys (public view, no callbacks) */
+  hotkeys: Signal<Array<HotkeyRegistrationView>>;
+  /** Signal for all registered sequences */
+  sequences: Signal<Array<SequenceRegistrationView>>;
+}
+/**
+ * Angular injectable that reactively reads all hotkey and sequence registrations
+ * from the singleton managers.
+ *
+ * This is a standalone injectable that does NOT require the HotkeysProvider.
+ * It subscribes to both HotkeyManager and SequenceManager stores and
+ * triggers change detection when registrations change.
+ *
+ * Must be called in an injection context (constructor, factory, or `inject()`).
+ *
+ * @returns Object with `hotkeys` and `sequences` signals
+ */
+declare function injectHotkeyRegistrations(): HotkeyRegistrationsResult;
+//#endregion
+export { HotkeyRegistrationsResult, injectHotkeyRegistrations };
+//# sourceMappingURL=injectHotkeyRegistrations.d.ts.map

package/dist/injectHotkeyRegistrations.js

@@ -0,0 +1,28 @@
+import { getHotkeyManager, getSequenceManager, toHotkeyRegistrationView } from "@tanstack/hotkeys";
+import { injectStore } from "@tanstack/angular-store";
+
+//#region src/injectHotkeyRegistrations.ts
+/**
+* Angular injectable that reactively reads all hotkey and sequence registrations
+* from the singleton managers.
+*
+* This is a standalone injectable that does NOT require the HotkeysProvider.
+* It subscribes to both HotkeyManager and SequenceManager stores and
+* triggers change detection when registrations change.
+*
+* Must be called in an injection context (constructor, factory, or `inject()`).
+*
+* @returns Object with `hotkeys` and `sequences` signals
+*/
+function injectHotkeyRegistrations() {
+	const hotkeyManager = getHotkeyManager();
+	const sequenceManager = getSequenceManager();
+	return {
+		hotkeys: injectStore(hotkeyManager.registrations, (state) => Array.from(state.values()).map(toHotkeyRegistrationView)),
+		sequences: injectStore(sequenceManager.registrations, (state) => Array.from(state.values()))
+	};
+}
+
+//#endregion
+export { injectHotkeyRegistrations };
+//# sourceMappingURL=injectHotkeyRegistrations.js.map

package/dist/injectHotkeyRegistrations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"injectHotkeyRegistrations.js","names":[],"sources":["../src/injectHotkeyRegistrations.ts"],"sourcesContent":["import { injectStore } from '@tanstack/angular-store'\nimport {\n  getHotkeyManager,\n  getSequenceManager,\n  toHotkeyRegistrationView,\n} from '@tanstack/hotkeys'\nimport type {\n  HotkeyRegistrationView,\n  SequenceRegistrationView,\n} from '@tanstack/hotkeys'\nimport type { Signal } from '@angular/core'\n\n/**\n * Return type for injectHotkeyRegistrations.\n */\nexport interface HotkeyRegistrationsResult {\n  /** Signal for all registered hotkeys (public view, no callbacks) */\n  hotkeys: Signal<Array<HotkeyRegistrationView>>\n  /** Signal for all registered sequences */\n  sequences: Signal<Array<SequenceRegistrationView>>\n}\n\n/**\n * Angular injectable that reactively reads all hotkey and sequence registrations\n * from the singleton managers.\n *\n * This is a standalone injectable that does NOT require the HotkeysProvider.\n * It subscribes to both HotkeyManager and SequenceManager stores and\n * triggers change detection when registrations change.\n *\n * Must be called in an injection context (constructor, factory, or `inject()`).\n *\n * @returns Object with `hotkeys` and `sequences` signals\n */\nexport function injectHotkeyRegistrations(): HotkeyRegistrationsResult {\n  const hotkeyManager = getHotkeyManager()\n  const sequenceManager = getSequenceManager()\n\n  const hotkeys = injectStore(hotkeyManager.registrations, (state) =>\n    Array.from(state.values()).map(toHotkeyRegistrationView),\n  )\n\n  const sequences = injectStore(sequenceManager.registrations, (state) =>\n    Array.from(state.values()),\n  )\n\n  return { hotkeys, sequences }\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAkCA,SAAgB,4BAAuD;CACrE,MAAM,gBAAgB,kBAAkB;CACxC,MAAM,kBAAkB,oBAAoB;AAU5C,QAAO;EAAE,SARO,YAAY,cAAc,gBAAgB,UACxD,MAAM,KAAK,MAAM,QAAQ,CAAC,CAAC,IAAI,yBAAyB,CACzD;EAMiB,WAJA,YAAY,gBAAgB,gBAAgB,UAC5D,MAAM,KAAK,MAAM,QAAQ,CAAC,CAC3B;EAE4B"}

package/dist/injectKeyHold.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"injectKeyHold.cjs","names":[],"sources":["../src/injectKeyHold.ts"],"sourcesContent":["import { computed } from '@angular/core'\nimport { injectStore } from '@tanstack/angular-store'\nimport { getKeyStateTracker } from '@tanstack/hotkeys'\nimport type { HeldKey } from '@tanstack/hotkeys'\nimport type { Signal } from '@angular/core'\n\n/**\n * Angular inject-based API that returns a signal that is true when the given key is held.\n *\n * Subscribes to the global KeyStateTracker and uses a computed to determine\n * if the specified key is held.\n *\n * @param key - The key to check (e.g. 'Shift', 'Control', 'Space') - can be a getter function\n * @returns Signal that returns true if the key is currently held down\n *\n * @example\n * ```ts\n * @Component({\n *   template: `{{ isShiftHeld() ? 'Shift is pressed!' : 'Press Shift' }}`,\n * })\n * export class ShiftIndicatorComponent {\n *   isShiftHeld = injectKeyHold('Shift')\n * }\n * ```\n *\n * @example\n * ```ts\n * @Component({\n *   template: `\n *     <span [style.opacity]=\"ctrl() ? 1 : 0.3\">Ctrl</span>\n *     <span [style.opacity]=\"shift() ? 1 : 0.3\">Shift</span>\n *   `,\n * })\n * export class ModifierIndicatorsComponent {\n *   ctrl = injectKeyHold('Control')\n *   shift = injectKeyHold('Shift')\n * }\n * ```\n */\nexport function injectKeyHold(key: HeldKey | (() => HeldKey)): Signal<boolean> {\n  const tracker = getKeyStateTracker()\n  const heldKeysSelector = injectStore(tracker.store, (state) => state.heldKeys)\n\n  return computed(() => {\n    const resolvedKey = typeof key === 'function' ? key() : key\n    const normalizedKey = resolvedKey.toLowerCase()\n\n    return heldKeysSelector().some(\n      (heldKey) => heldKey.toLowerCase() === normalizedKey,\n    )\n  })\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuCA,SAAgB,cAAc,KAAiD;CAE7E,MAAM,uGAD8B,CACS,QAAQ,UAAU,MAAM,SAAS;AAE9E,0CAAsB;EAEpB,MAAM,iBADc,OAAO,QAAQ,aAAa,KAAK,GAAG,KACtB,aAAa;AAE/C,SAAO,kBAAkB,CAAC,MACvB,YAAY,QAAQ,aAAa,KAAK,cACxC;GACD"}
+{"version":3,"file":"injectKeyHold.cjs","names":[],"sources":["../src/injectKeyHold.ts"],"sourcesContent":["import { computed } from '@angular/core'\nimport { injectStore } from '@tanstack/angular-store'\nimport { getKeyStateTracker } from '@tanstack/hotkeys'\nimport type { IndividualKey } from '@tanstack/hotkeys'\nimport type { Signal } from '@angular/core'\n\n/**\n * Angular inject-based API that returns a signal that is true when the given key is held.\n *\n * Subscribes to the global KeyStateTracker and uses a computed to determine\n * if the specified key is held.\n *\n * @param key - The key to check (e.g. 'Shift', 'Control', 'Space') - can be a getter function\n * @returns Signal that returns true if the key is currently held down\n *\n * @example\n * ```ts\n * @Component({\n *   template: `{{ isShiftHeld() ? 'Shift is pressed!' : 'Press Shift' }}`,\n * })\n * export class ShiftIndicatorComponent {\n *   isShiftHeld = injectKeyHold('Shift')\n * }\n * ```\n *\n * @example\n * ```ts\n * @Component({\n *   template: `\n *     <span [style.opacity]=\"ctrl() ? 1 : 0.3\">Ctrl</span>\n *     <span [style.opacity]=\"shift() ? 1 : 0.3\">Shift</span>\n *   `,\n * })\n * export class ModifierIndicatorsComponent {\n *   ctrl = injectKeyHold('Control')\n *   shift = injectKeyHold('Shift')\n * }\n * ```\n */\nexport function injectKeyHold(\n  key: IndividualKey | (() => IndividualKey),\n): Signal<boolean> {\n  const tracker = getKeyStateTracker()\n  const heldKeysSelector = injectStore(tracker.store, (state) => state.heldKeys)\n\n  return computed(() => {\n    const resolvedKey = typeof key === 'function' ? key() : key\n    const normalizedKey = resolvedKey.toLowerCase()\n\n    return heldKeysSelector().some(\n      (heldKey) => heldKey.toLowerCase() === normalizedKey,\n    )\n  })\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuCA,SAAgB,cACd,KACiB;CAEjB,MAAM,uGAD8B,CACS,QAAQ,UAAU,MAAM,SAAS;AAE9E,0CAAsB;EAEpB,MAAM,iBADc,OAAO,QAAQ,aAAa,KAAK,GAAG,KACtB,aAAa;AAE/C,SAAO,kBAAkB,CAAC,MACvB,YAAY,QAAQ,aAAa,KAAK,cACxC;GACD"}

package/dist/injectKeyHold.d.cts

@@ -1,4 +1,4 @@
-import { HeldKey } from "@tanstack/hotkeys";
+import { IndividualKey } from "@tanstack/hotkeys";
 import { Signal } from "@angular/core";
 
 //#region src/injectKeyHold.d.ts
@@ -35,7 +35,7 @@ import { Signal } from "@angular/core";
  * }
  * ```
  */
-declare function injectKeyHold(key: HeldKey | (() => HeldKey)): Signal<boolean>;
+declare function injectKeyHold(key: IndividualKey | (() => IndividualKey)): Signal<boolean>;
 //#endregion
 export { injectKeyHold };
 //# sourceMappingURL=injectKeyHold.d.cts.map

package/dist/injectKeyHold.d.ts

@@ -1,4 +1,4 @@
-import { HeldKey } from "@tanstack/hotkeys";
+import { IndividualKey } from "@tanstack/hotkeys";
 import { Signal } from "@angular/core";
 
 //#region src/injectKeyHold.d.ts
@@ -35,7 +35,7 @@ import { Signal } from "@angular/core";
  * }
  * ```
  */
-declare function injectKeyHold(key: HeldKey | (() => HeldKey)): Signal<boolean>;
+declare function injectKeyHold(key: IndividualKey | (() => IndividualKey)): Signal<boolean>;
 //#endregion
 export { injectKeyHold };
 //# sourceMappingURL=injectKeyHold.d.ts.map

package/dist/injectKeyHold.js.map

@@ -1 +1 @@
-{"version":3,"file":"injectKeyHold.js","names":[],"sources":["../src/injectKeyHold.ts"],"sourcesContent":["import { computed } from '@angular/core'\nimport { injectStore } from '@tanstack/angular-store'\nimport { getKeyStateTracker } from '@tanstack/hotkeys'\nimport type { HeldKey } from '@tanstack/hotkeys'\nimport type { Signal } from '@angular/core'\n\n/**\n * Angular inject-based API that returns a signal that is true when the given key is held.\n *\n * Subscribes to the global KeyStateTracker and uses a computed to determine\n * if the specified key is held.\n *\n * @param key - The key to check (e.g. 'Shift', 'Control', 'Space') - can be a getter function\n * @returns Signal that returns true if the key is currently held down\n *\n * @example\n * ```ts\n * @Component({\n *   template: `{{ isShiftHeld() ? 'Shift is pressed!' : 'Press Shift' }}`,\n * })\n * export class ShiftIndicatorComponent {\n *   isShiftHeld = injectKeyHold('Shift')\n * }\n * ```\n *\n * @example\n * ```ts\n * @Component({\n *   template: `\n *     <span [style.opacity]=\"ctrl() ? 1 : 0.3\">Ctrl</span>\n *     <span [style.opacity]=\"shift() ? 1 : 0.3\">Shift</span>\n *   `,\n * })\n * export class ModifierIndicatorsComponent {\n *   ctrl = injectKeyHold('Control')\n *   shift = injectKeyHold('Shift')\n * }\n * ```\n */\nexport function injectKeyHold(key: HeldKey | (() => HeldKey)): Signal<boolean> {\n  const tracker = getKeyStateTracker()\n  const heldKeysSelector = injectStore(tracker.store, (state) => state.heldKeys)\n\n  return computed(() => {\n    const resolvedKey = typeof key === 'function' ? key() : key\n    const normalizedKey = resolvedKey.toLowerCase()\n\n    return heldKeysSelector().some(\n      (heldKey) => heldKey.toLowerCase() === normalizedKey,\n    )\n  })\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuCA,SAAgB,cAAc,KAAiD;CAE7E,MAAM,mBAAmB,YADT,oBAAoB,CACS,QAAQ,UAAU,MAAM,SAAS;AAE9E,QAAO,eAAe;EAEpB,MAAM,iBADc,OAAO,QAAQ,aAAa,KAAK,GAAG,KACtB,aAAa;AAE/C,SAAO,kBAAkB,CAAC,MACvB,YAAY,QAAQ,aAAa,KAAK,cACxC;GACD"}
+{"version":3,"file":"injectKeyHold.js","names":[],"sources":["../src/injectKeyHold.ts"],"sourcesContent":["import { computed } from '@angular/core'\nimport { injectStore } from '@tanstack/angular-store'\nimport { getKeyStateTracker } from '@tanstack/hotkeys'\nimport type { IndividualKey } from '@tanstack/hotkeys'\nimport type { Signal } from '@angular/core'\n\n/**\n * Angular inject-based API that returns a signal that is true when the given key is held.\n *\n * Subscribes to the global KeyStateTracker and uses a computed to determine\n * if the specified key is held.\n *\n * @param key - The key to check (e.g. 'Shift', 'Control', 'Space') - can be a getter function\n * @returns Signal that returns true if the key is currently held down\n *\n * @example\n * ```ts\n * @Component({\n *   template: `{{ isShiftHeld() ? 'Shift is pressed!' : 'Press Shift' }}`,\n * })\n * export class ShiftIndicatorComponent {\n *   isShiftHeld = injectKeyHold('Shift')\n * }\n * ```\n *\n * @example\n * ```ts\n * @Component({\n *   template: `\n *     <span [style.opacity]=\"ctrl() ? 1 : 0.3\">Ctrl</span>\n *     <span [style.opacity]=\"shift() ? 1 : 0.3\">Shift</span>\n *   `,\n * })\n * export class ModifierIndicatorsComponent {\n *   ctrl = injectKeyHold('Control')\n *   shift = injectKeyHold('Shift')\n * }\n * ```\n */\nexport function injectKeyHold(\n  key: IndividualKey | (() => IndividualKey),\n): Signal<boolean> {\n  const tracker = getKeyStateTracker()\n  const heldKeysSelector = injectStore(tracker.store, (state) => state.heldKeys)\n\n  return computed(() => {\n    const resolvedKey = typeof key === 'function' ? key() : key\n    const normalizedKey = resolvedKey.toLowerCase()\n\n    return heldKeysSelector().some(\n      (heldKey) => heldKey.toLowerCase() === normalizedKey,\n    )\n  })\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuCA,SAAgB,cACd,KACiB;CAEjB,MAAM,mBAAmB,YADT,oBAAoB,CACS,QAAQ,UAAU,MAAM,SAAS;AAE9E,QAAO,eAAe;EAEpB,MAAM,iBADc,OAAO,QAAQ,aAAa,KAAK,GAAG,KACtB,aAAa;AAE/C,SAAO,kBAAkB,CAAC,MACvB,YAAY,QAAQ,aAAa,KAAK,cACxC;GACD"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/angular-hotkeys",
-  "version": "0.8.3",
+  "version": "0.9.0",
   "description": "Angular adapter for TanStack Hotkeys",
   "author": "Tanner Linsley",
   "license": "MIT",
@@ -42,17 +42,17 @@
   ],
   "dependencies": {
     "@tanstack/angular-store": "^0.9.3",
-    "@tanstack/hotkeys": "0.6.3"
+    "@tanstack/hotkeys": "0.7.0"
   },
   "peerDependencies": {
     "@angular/common": ">=19.0.0",
     "@angular/core": ">=19.0.0"
   },
   "devDependencies": {
-    "@angular/common": "^21.2.5",
-    "@angular/core": "^21.2.5",
-    "@angular/platform-browser-dynamic": "^21.2.5",
-    "typescript": "5.9.3"
+    "@angular/common": "^21.2.6",
+    "@angular/core": "^21.2.6",
+    "@angular/platform-browser-dynamic": "^21.2.6",
+    "typescript": "6.0.2"
   },
   "scripts": {
     "clean": "premove ./build ./dist",

package/src/index.ts

@@ -13,4 +13,5 @@ export * from './injectHeldKeys'
 export * from './injectHeldKeyCodes'
 export * from './injectKeyHold'
 export * from './injectHotkeyRecorder'
+export * from './injectHotkeyRegistrations'
 export * from './injectHotkeySequenceRecorder'

package/src/injectHotkeyRegistrations.ts

@@ -0,0 +1,48 @@
+import { injectStore } from '@tanstack/angular-store'
+import {
+  getHotkeyManager,
+  getSequenceManager,
+  toHotkeyRegistrationView,
+} from '@tanstack/hotkeys'
+import type {
+  HotkeyRegistrationView,
+  SequenceRegistrationView,
+} from '@tanstack/hotkeys'
+import type { Signal } from '@angular/core'
+
+/**
+ * Return type for injectHotkeyRegistrations.
+ */
+export interface HotkeyRegistrationsResult {
+  /** Signal for all registered hotkeys (public view, no callbacks) */
+  hotkeys: Signal<Array<HotkeyRegistrationView>>
+  /** Signal for all registered sequences */
+  sequences: Signal<Array<SequenceRegistrationView>>
+}
+
+/**
+ * Angular injectable that reactively reads all hotkey and sequence registrations
+ * from the singleton managers.
+ *
+ * This is a standalone injectable that does NOT require the HotkeysProvider.
+ * It subscribes to both HotkeyManager and SequenceManager stores and
+ * triggers change detection when registrations change.
+ *
+ * Must be called in an injection context (constructor, factory, or `inject()`).
+ *
+ * @returns Object with `hotkeys` and `sequences` signals
+ */
+export function injectHotkeyRegistrations(): HotkeyRegistrationsResult {
+  const hotkeyManager = getHotkeyManager()
+  const sequenceManager = getSequenceManager()
+
+  const hotkeys = injectStore(hotkeyManager.registrations, (state) =>
+    Array.from(state.values()).map(toHotkeyRegistrationView),
+  )
+
+  const sequences = injectStore(sequenceManager.registrations, (state) =>
+    Array.from(state.values()),
+  )
+
+  return { hotkeys, sequences }
+}

package/src/injectKeyHold.ts

@@ -1,7 +1,7 @@
 import { computed } from '@angular/core'
 import { injectStore } from '@tanstack/angular-store'
 import { getKeyStateTracker } from '@tanstack/hotkeys'
-import type { HeldKey } from '@tanstack/hotkeys'
+import type { IndividualKey } from '@tanstack/hotkeys'
 import type { Signal } from '@angular/core'
 
 /**
@@ -37,7 +37,9 @@ import type { Signal } from '@angular/core'
  * }
  * ```
  */
-export function injectKeyHold(key: HeldKey | (() => HeldKey)): Signal<boolean> {
+export function injectKeyHold(
+  key: IndividualKey | (() => IndividualKey),
+): Signal<boolean> {
   const tracker = getKeyStateTracker()
   const heldKeysSelector = injectStore(tracker.store, (state) => state.heldKeys)