@tanstack/preact-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/HotkeysProvider.d.cts

@@ -1,7 +1,7 @@
 import { UseHotkeyOptions } from "./useHotkey.cjs";
 import { UseHotkeySequenceOptions } from "./useHotkeySequence.cjs";
 import { HotkeyRecorderOptions, HotkeySequenceRecorderOptions } from "@tanstack/hotkeys";
-import * as preact from "preact";
+import * as _$preact from "preact";
 import { ComponentChildren } from "preact";
 
 //#region src/HotkeysProvider.d.ts
@@ -21,7 +21,7 @@ interface HotkeysProviderProps {
 declare function HotkeysProvider({
   children,
   defaultOptions
-}: HotkeysProviderProps): preact.JSX.Element;
+}: HotkeysProviderProps): _$preact.JSX.Element;
 declare function useHotkeysContext(): HotkeysContextValue | null;
 declare function useDefaultHotkeysOptions(): HotkeysProviderOptions;
 //#endregion

package/dist/HotkeysProvider.d.ts

@@ -1,7 +1,7 @@
 import { UseHotkeyOptions } from "./useHotkey.js";
 import { UseHotkeySequenceOptions } from "./useHotkeySequence.js";
 import { HotkeyRecorderOptions, HotkeySequenceRecorderOptions } from "@tanstack/hotkeys";
-import * as preact from "preact";
+import * as _$preact from "preact";
 import { ComponentChildren } from "preact";
 
 //#region src/HotkeysProvider.d.ts
@@ -21,7 +21,7 @@ interface HotkeysProviderProps {
 declare function HotkeysProvider({
   children,
   defaultOptions
-}: HotkeysProviderProps): preact.JSX.Element;
+}: HotkeysProviderProps): _$preact.JSX.Element;
 declare function useHotkeysContext(): HotkeysContextValue | null;
 declare function useDefaultHotkeysOptions(): HotkeysProviderOptions;
 //#endregion

package/dist/index.cjs

@@ -8,6 +8,7 @@ const require_useKeyHold = require('./useKeyHold.cjs');
 const require_useHotkeySequence = require('./useHotkeySequence.cjs');
 const require_useHotkeySequences = require('./useHotkeySequences.cjs');
 const require_useHotkeyRecorder = require('./useHotkeyRecorder.cjs');
+const require_useHotkeyRegistrations = require('./useHotkeyRegistrations.cjs');
 const require_useHotkeySequenceRecorder = require('./useHotkeySequenceRecorder.cjs');
 
 exports.HotkeysProvider = require_HotkeysProvider.HotkeysProvider;
@@ -16,6 +17,7 @@ exports.useHeldKeyCodes = require_useHeldKeyCodes.useHeldKeyCodes;
 exports.useHeldKeys = require_useHeldKeys.useHeldKeys;
 exports.useHotkey = require_useHotkey.useHotkey;
 exports.useHotkeyRecorder = require_useHotkeyRecorder.useHotkeyRecorder;
+exports.useHotkeyRegistrations = require_useHotkeyRegistrations.useHotkeyRegistrations;
 exports.useHotkeySequence = require_useHotkeySequence.useHotkeySequence;
 exports.useHotkeySequenceRecorder = require_useHotkeySequenceRecorder.useHotkeySequenceRecorder;
 exports.useHotkeySequences = require_useHotkeySequences.useHotkeySequences;

package/dist/index.d.cts

@@ -7,6 +7,7 @@ import { useHeldKeyCodes } from "./useHeldKeyCodes.cjs";
 import { useKeyHold } from "./useKeyHold.cjs";
 import { UseHotkeySequenceDefinition, useHotkeySequences } from "./useHotkeySequences.cjs";
 import { PreactHotkeyRecorder, useHotkeyRecorder } from "./useHotkeyRecorder.cjs";
+import { HotkeyRegistrationsResult, useHotkeyRegistrations } from "./useHotkeyRegistrations.cjs";
 import { PreactHotkeySequenceRecorder, useHotkeySequenceRecorder } from "./useHotkeySequenceRecorder.cjs";
 export * from "@tanstack/hotkeys";
-export { HotkeysProvider, HotkeysProviderOptions, HotkeysProviderProps, PreactHotkeyRecorder, PreactHotkeySequenceRecorder, UseHotkeyDefinition, UseHotkeyOptions, UseHotkeySequenceDefinition, UseHotkeySequenceOptions, useDefaultHotkeysOptions, useHeldKeyCodes, useHeldKeys, useHotkey, useHotkeyRecorder, useHotkeySequence, useHotkeySequenceRecorder, useHotkeySequences, useHotkeys, useHotkeysContext, useKeyHold };
+export { HotkeyRegistrationsResult, HotkeysProvider, HotkeysProviderOptions, HotkeysProviderProps, PreactHotkeyRecorder, PreactHotkeySequenceRecorder, UseHotkeyDefinition, UseHotkeyOptions, UseHotkeySequenceDefinition, UseHotkeySequenceOptions, useDefaultHotkeysOptions, useHeldKeyCodes, useHeldKeys, useHotkey, useHotkeyRecorder, useHotkeyRegistrations, useHotkeySequence, useHotkeySequenceRecorder, useHotkeySequences, useHotkeys, useHotkeysContext, useKeyHold };

package/dist/index.d.ts

@@ -7,6 +7,7 @@ import { useHeldKeyCodes } from "./useHeldKeyCodes.js";
 import { useKeyHold } from "./useKeyHold.js";
 import { UseHotkeySequenceDefinition, useHotkeySequences } from "./useHotkeySequences.js";
 import { PreactHotkeyRecorder, useHotkeyRecorder } from "./useHotkeyRecorder.js";
+import { HotkeyRegistrationsResult, useHotkeyRegistrations } from "./useHotkeyRegistrations.js";
 import { PreactHotkeySequenceRecorder, useHotkeySequenceRecorder } from "./useHotkeySequenceRecorder.js";
 export * from "@tanstack/hotkeys";
-export { HotkeysProvider, HotkeysProviderOptions, HotkeysProviderProps, PreactHotkeyRecorder, PreactHotkeySequenceRecorder, UseHotkeyDefinition, UseHotkeyOptions, UseHotkeySequenceDefinition, UseHotkeySequenceOptions, useDefaultHotkeysOptions, useHeldKeyCodes, useHeldKeys, useHotkey, useHotkeyRecorder, useHotkeySequence, useHotkeySequenceRecorder, useHotkeySequences, useHotkeys, useHotkeysContext, useKeyHold };
+export { HotkeyRegistrationsResult, HotkeysProvider, HotkeysProviderOptions, HotkeysProviderProps, PreactHotkeyRecorder, PreactHotkeySequenceRecorder, UseHotkeyDefinition, UseHotkeyOptions, UseHotkeySequenceDefinition, UseHotkeySequenceOptions, useDefaultHotkeysOptions, useHeldKeyCodes, useHeldKeys, useHotkey, useHotkeyRecorder, useHotkeyRegistrations, useHotkeySequence, useHotkeySequenceRecorder, useHotkeySequences, useHotkeys, useHotkeysContext, useKeyHold };

package/dist/index.js

@@ -7,8 +7,9 @@ import { useKeyHold } from "./useKeyHold.js";
 import { useHotkeySequence } from "./useHotkeySequence.js";
 import { useHotkeySequences } from "./useHotkeySequences.js";
 import { useHotkeyRecorder } from "./useHotkeyRecorder.js";
+import { useHotkeyRegistrations } from "./useHotkeyRegistrations.js";
 import { useHotkeySequenceRecorder } from "./useHotkeySequenceRecorder.js";
 
 export * from "@tanstack/hotkeys"
 
-export { HotkeysProvider, useDefaultHotkeysOptions, useHeldKeyCodes, useHeldKeys, useHotkey, useHotkeyRecorder, useHotkeySequence, useHotkeySequenceRecorder, useHotkeySequences, useHotkeys, useHotkeysContext, useKeyHold };
+export { HotkeysProvider, useDefaultHotkeysOptions, useHeldKeyCodes, useHeldKeys, useHotkey, useHotkeyRecorder, useHotkeyRegistrations, useHotkeySequence, useHotkeySequenceRecorder, useHotkeySequences, useHotkeys, useHotkeysContext, useKeyHold };

package/dist/useHotkeyRegistrations.cjs

@@ -0,0 +1,26 @@
+let _tanstack_hotkeys = require("@tanstack/hotkeys");
+let _tanstack_preact_store = require("@tanstack/preact-store");
+
+//#region src/useHotkeyRegistrations.ts
+/**
+* Preact hook that reactively reads all hotkey and sequence registrations
+* from the singleton managers.
+*
+* This is a standalone hook that does NOT require the HotkeysProvider.
+* It subscribes to both HotkeyManager and SequenceManager stores and
+* re-renders when registrations change.
+*
+* @returns Object with `hotkeys` and `sequences` arrays
+*/
+function useHotkeyRegistrations() {
+	const hotkeyManager = (0, _tanstack_hotkeys.getHotkeyManager)();
+	const sequenceManager = (0, _tanstack_hotkeys.getSequenceManager)();
+	return {
+		hotkeys: (0, _tanstack_preact_store.useStore)(hotkeyManager.registrations, (state) => Array.from(state.values()).map(_tanstack_hotkeys.toHotkeyRegistrationView)),
+		sequences: (0, _tanstack_preact_store.useStore)(sequenceManager.registrations, (state) => Array.from(state.values()))
+	};
+}
+
+//#endregion
+exports.useHotkeyRegistrations = useHotkeyRegistrations;
+//# sourceMappingURL=useHotkeyRegistrations.cjs.map

package/dist/useHotkeyRegistrations.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"useHotkeyRegistrations.cjs","names":["toHotkeyRegistrationView"],"sources":["../src/useHotkeyRegistrations.ts"],"sourcesContent":["import { useStore } from '@tanstack/preact-store'\nimport {\n  getHotkeyManager,\n  getSequenceManager,\n  toHotkeyRegistrationView,\n} from '@tanstack/hotkeys'\nimport type {\n  HotkeyRegistrationView,\n  SequenceRegistrationView,\n} from '@tanstack/hotkeys'\n\n/**\n * Return type for useHotkeyRegistrations.\n */\nexport interface HotkeyRegistrationsResult {\n  /** All registered hotkeys (public view, no callbacks) */\n  hotkeys: Array<HotkeyRegistrationView>\n  /** All registered sequences */\n  sequences: Array<SequenceRegistrationView>\n}\n\n/**\n * Preact hook that reactively reads all hotkey and sequence registrations\n * from the singleton managers.\n *\n * This is a standalone hook that does NOT require the HotkeysProvider.\n * It subscribes to both HotkeyManager and SequenceManager stores and\n * re-renders when registrations change.\n *\n * @returns Object with `hotkeys` and `sequences` arrays\n */\nexport function useHotkeyRegistrations(): HotkeyRegistrationsResult {\n  const hotkeyManager = getHotkeyManager()\n  const sequenceManager = getSequenceManager()\n\n  const hotkeys = useStore(hotkeyManager.registrations, (state) =>\n    Array.from(state.values()).map(toHotkeyRegistrationView),\n  )\n\n  const sequences = useStore(sequenceManager.registrations, (state) =>\n    Array.from(state.values()),\n  )\n\n  return { hotkeys, sequences }\n}\n"],"mappings":";;;;;;;;;;;;;;AA+BA,SAAgB,yBAAoD;CAClE,MAAM,yDAAkC;CACxC,MAAM,6DAAsC;AAU5C,QAAO;EAAE,8CARgB,cAAc,gBAAgB,UACrD,MAAM,KAAK,MAAM,QAAQ,CAAC,CAAC,IAAIA,2CAAyB,CACzD;EAMiB,gDAJS,gBAAgB,gBAAgB,UACzD,MAAM,KAAK,MAAM,QAAQ,CAAC,CAC3B;EAE4B"}

package/dist/useHotkeyRegistrations.d.cts

@@ -0,0 +1,26 @@
+import { HotkeyRegistrationView, SequenceRegistrationView } from "@tanstack/hotkeys";
+
+//#region src/useHotkeyRegistrations.d.ts
+/**
+ * Return type for useHotkeyRegistrations.
+ */
+interface HotkeyRegistrationsResult {
+  /** All registered hotkeys (public view, no callbacks) */
+  hotkeys: Array<HotkeyRegistrationView>;
+  /** All registered sequences */
+  sequences: Array<SequenceRegistrationView>;
+}
+/**
+ * Preact hook that reactively reads all hotkey and sequence registrations
+ * from the singleton managers.
+ *
+ * This is a standalone hook that does NOT require the HotkeysProvider.
+ * It subscribes to both HotkeyManager and SequenceManager stores and
+ * re-renders when registrations change.
+ *
+ * @returns Object with `hotkeys` and `sequences` arrays
+ */
+declare function useHotkeyRegistrations(): HotkeyRegistrationsResult;
+//#endregion
+export { HotkeyRegistrationsResult, useHotkeyRegistrations };
+//# sourceMappingURL=useHotkeyRegistrations.d.cts.map

package/dist/useHotkeyRegistrations.d.ts

@@ -0,0 +1,26 @@
+import { HotkeyRegistrationView, SequenceRegistrationView } from "@tanstack/hotkeys";
+
+//#region src/useHotkeyRegistrations.d.ts
+/**
+ * Return type for useHotkeyRegistrations.
+ */
+interface HotkeyRegistrationsResult {
+  /** All registered hotkeys (public view, no callbacks) */
+  hotkeys: Array<HotkeyRegistrationView>;
+  /** All registered sequences */
+  sequences: Array<SequenceRegistrationView>;
+}
+/**
+ * Preact hook that reactively reads all hotkey and sequence registrations
+ * from the singleton managers.
+ *
+ * This is a standalone hook that does NOT require the HotkeysProvider.
+ * It subscribes to both HotkeyManager and SequenceManager stores and
+ * re-renders when registrations change.
+ *
+ * @returns Object with `hotkeys` and `sequences` arrays
+ */
+declare function useHotkeyRegistrations(): HotkeyRegistrationsResult;
+//#endregion
+export { HotkeyRegistrationsResult, useHotkeyRegistrations };
+//# sourceMappingURL=useHotkeyRegistrations.d.ts.map

package/dist/useHotkeyRegistrations.js

@@ -0,0 +1,26 @@
+import { getHotkeyManager, getSequenceManager, toHotkeyRegistrationView } from "@tanstack/hotkeys";
+import { useStore } from "@tanstack/preact-store";
+
+//#region src/useHotkeyRegistrations.ts
+/**
+* Preact hook that reactively reads all hotkey and sequence registrations
+* from the singleton managers.
+*
+* This is a standalone hook that does NOT require the HotkeysProvider.
+* It subscribes to both HotkeyManager and SequenceManager stores and
+* re-renders when registrations change.
+*
+* @returns Object with `hotkeys` and `sequences` arrays
+*/
+function useHotkeyRegistrations() {
+	const hotkeyManager = getHotkeyManager();
+	const sequenceManager = getSequenceManager();
+	return {
+		hotkeys: useStore(hotkeyManager.registrations, (state) => Array.from(state.values()).map(toHotkeyRegistrationView)),
+		sequences: useStore(sequenceManager.registrations, (state) => Array.from(state.values()))
+	};
+}
+
+//#endregion
+export { useHotkeyRegistrations };
+//# sourceMappingURL=useHotkeyRegistrations.js.map

package/dist/useHotkeyRegistrations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useHotkeyRegistrations.js","names":[],"sources":["../src/useHotkeyRegistrations.ts"],"sourcesContent":["import { useStore } from '@tanstack/preact-store'\nimport {\n  getHotkeyManager,\n  getSequenceManager,\n  toHotkeyRegistrationView,\n} from '@tanstack/hotkeys'\nimport type {\n  HotkeyRegistrationView,\n  SequenceRegistrationView,\n} from '@tanstack/hotkeys'\n\n/**\n * Return type for useHotkeyRegistrations.\n */\nexport interface HotkeyRegistrationsResult {\n  /** All registered hotkeys (public view, no callbacks) */\n  hotkeys: Array<HotkeyRegistrationView>\n  /** All registered sequences */\n  sequences: Array<SequenceRegistrationView>\n}\n\n/**\n * Preact hook that reactively reads all hotkey and sequence registrations\n * from the singleton managers.\n *\n * This is a standalone hook that does NOT require the HotkeysProvider.\n * It subscribes to both HotkeyManager and SequenceManager stores and\n * re-renders when registrations change.\n *\n * @returns Object with `hotkeys` and `sequences` arrays\n */\nexport function useHotkeyRegistrations(): HotkeyRegistrationsResult {\n  const hotkeyManager = getHotkeyManager()\n  const sequenceManager = getSequenceManager()\n\n  const hotkeys = useStore(hotkeyManager.registrations, (state) =>\n    Array.from(state.values()).map(toHotkeyRegistrationView),\n  )\n\n  const sequences = useStore(sequenceManager.registrations, (state) =>\n    Array.from(state.values()),\n  )\n\n  return { hotkeys, sequences }\n}\n"],"mappings":";;;;;;;;;;;;;;AA+BA,SAAgB,yBAAoD;CAClE,MAAM,gBAAgB,kBAAkB;CACxC,MAAM,kBAAkB,oBAAoB;AAU5C,QAAO;EAAE,SARO,SAAS,cAAc,gBAAgB,UACrD,MAAM,KAAK,MAAM,QAAQ,CAAC,CAAC,IAAI,yBAAyB,CACzD;EAMiB,WAJA,SAAS,gBAAgB,gBAAgB,UACzD,MAAM,KAAK,MAAM,QAAQ,CAAC,CAC3B;EAE4B"}

package/dist/useKeyHold.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"useKeyHold.cjs","names":[],"sources":["../src/useKeyHold.ts"],"sourcesContent":["import { useStore } from '@tanstack/preact-store'\nimport { getKeyStateTracker } from '@tanstack/hotkeys'\nimport type { HeldKey } from '@tanstack/hotkeys'\n\n/**\n * Preact hook that returns whether a specific key is currently being held.\n *\n * This hook uses `useStore` from `@tanstack/preact-store` to subscribe\n * to the global KeyStateTracker and uses a selector to determine if\n * the specified key is held.\n *\n * @param key - The key to check (e.g., 'Shift', 'Control', 'A')\n * @returns True if the key is currently held down\n *\n * @example\n * ```tsx\n * function ShiftIndicator() {\n *   const isShiftHeld = useKeyHold('Shift')\n *\n *   return (\n *     <div style={{ opacity: isShiftHeld ? 1 : 0.5 }}>\n *       {isShiftHeld ? 'Shift is pressed!' : 'Press Shift'}\n *     </div>\n *   )\n * }\n * ```\n *\n * @example\n * ```tsx\n * function ModifierIndicators() {\n *   const ctrl = useKeyHold('Control')\n *   const shift = useKeyHold('Shift')\n *   const alt = useKeyHold('Alt')\n *\n *   return (\n *     <div>\n *       <span style={{ opacity: ctrl ? 1 : 0.3 }}>Ctrl</span>\n *       <span style={{ opacity: shift ? 1 : 0.3 }}>Shift</span>\n *       <span style={{ opacity: alt ? 1 : 0.3 }}>Alt</span>\n *     </div>\n *   )\n * }\n * ```\n */\nexport function useKeyHold(key: HeldKey): boolean {\n  const tracker = getKeyStateTracker()\n  const normalizedKey = key.toLowerCase()\n\n  return useStore(tracker.store, (state) =>\n    state.heldKeys.some((heldKey) => heldKey.toLowerCase() === normalizedKey),\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4CA,SAAgB,WAAW,KAAuB;CAChD,MAAM,qDAA8B;CACpC,MAAM,gBAAgB,IAAI,aAAa;AAEvC,6CAAgB,QAAQ,QAAQ,UAC9B,MAAM,SAAS,MAAM,YAAY,QAAQ,aAAa,KAAK,cAAc,CAC1E"}
+{"version":3,"file":"useKeyHold.cjs","names":[],"sources":["../src/useKeyHold.ts"],"sourcesContent":["import { useStore } from '@tanstack/preact-store'\nimport { getKeyStateTracker } from '@tanstack/hotkeys'\nimport type { IndividualKey } from '@tanstack/hotkeys'\n\n/**\n * Preact hook that returns whether a specific key is currently being held.\n *\n * This hook uses `useStore` from `@tanstack/preact-store` to subscribe\n * to the global KeyStateTracker and uses a selector to determine if\n * the specified key is held.\n *\n * @param key - The key to check (e.g., 'Shift', 'Control', 'A')\n * @returns True if the key is currently held down\n *\n * @example\n * ```tsx\n * function ShiftIndicator() {\n *   const isShiftHeld = useKeyHold('Shift')\n *\n *   return (\n *     <div style={{ opacity: isShiftHeld ? 1 : 0.5 }}>\n *       {isShiftHeld ? 'Shift is pressed!' : 'Press Shift'}\n *     </div>\n *   )\n * }\n * ```\n *\n * @example\n * ```tsx\n * function ModifierIndicators() {\n *   const ctrl = useKeyHold('Control')\n *   const shift = useKeyHold('Shift')\n *   const alt = useKeyHold('Alt')\n *\n *   return (\n *     <div>\n *       <span style={{ opacity: ctrl ? 1 : 0.3 }}>Ctrl</span>\n *       <span style={{ opacity: shift ? 1 : 0.3 }}>Shift</span>\n *       <span style={{ opacity: alt ? 1 : 0.3 }}>Alt</span>\n *     </div>\n *   )\n * }\n * ```\n */\nexport function useKeyHold(key: IndividualKey): boolean {\n  const tracker = getKeyStateTracker()\n  const normalizedKey = key.toLowerCase()\n\n  return useStore(tracker.store, (state) =>\n    state.heldKeys.some((heldKey) => heldKey.toLowerCase() === normalizedKey),\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4CA,SAAgB,WAAW,KAA6B;CACtD,MAAM,qDAA8B;CACpC,MAAM,gBAAgB,IAAI,aAAa;AAEvC,6CAAgB,QAAQ,QAAQ,UAC9B,MAAM,SAAS,MAAM,YAAY,QAAQ,aAAa,KAAK,cAAc,CAC1E"}

package/dist/useKeyHold.d.cts

@@ -1,4 +1,4 @@
-import { HeldKey } from "@tanstack/hotkeys";
+import { IndividualKey } from "@tanstack/hotkeys";
 
 //#region src/useKeyHold.d.ts
 /**
@@ -41,7 +41,7 @@ import { HeldKey } from "@tanstack/hotkeys";
  * }
  * ```
  */
-declare function useKeyHold(key: HeldKey): boolean;
+declare function useKeyHold(key: IndividualKey): boolean;
 //#endregion
 export { useKeyHold };
 //# sourceMappingURL=useKeyHold.d.cts.map

package/dist/useKeyHold.d.ts

@@ -1,4 +1,4 @@
-import { HeldKey } from "@tanstack/hotkeys";
+import { IndividualKey } from "@tanstack/hotkeys";
 
 //#region src/useKeyHold.d.ts
 /**
@@ -41,7 +41,7 @@ import { HeldKey } from "@tanstack/hotkeys";
  * }
  * ```
  */
-declare function useKeyHold(key: HeldKey): boolean;
+declare function useKeyHold(key: IndividualKey): boolean;
 //#endregion
 export { useKeyHold };
 //# sourceMappingURL=useKeyHold.d.ts.map

package/dist/useKeyHold.js.map

@@ -1 +1 @@
-{"version":3,"file":"useKeyHold.js","names":[],"sources":["../src/useKeyHold.ts"],"sourcesContent":["import { useStore } from '@tanstack/preact-store'\nimport { getKeyStateTracker } from '@tanstack/hotkeys'\nimport type { HeldKey } from '@tanstack/hotkeys'\n\n/**\n * Preact hook that returns whether a specific key is currently being held.\n *\n * This hook uses `useStore` from `@tanstack/preact-store` to subscribe\n * to the global KeyStateTracker and uses a selector to determine if\n * the specified key is held.\n *\n * @param key - The key to check (e.g., 'Shift', 'Control', 'A')\n * @returns True if the key is currently held down\n *\n * @example\n * ```tsx\n * function ShiftIndicator() {\n *   const isShiftHeld = useKeyHold('Shift')\n *\n *   return (\n *     <div style={{ opacity: isShiftHeld ? 1 : 0.5 }}>\n *       {isShiftHeld ? 'Shift is pressed!' : 'Press Shift'}\n *     </div>\n *   )\n * }\n * ```\n *\n * @example\n * ```tsx\n * function ModifierIndicators() {\n *   const ctrl = useKeyHold('Control')\n *   const shift = useKeyHold('Shift')\n *   const alt = useKeyHold('Alt')\n *\n *   return (\n *     <div>\n *       <span style={{ opacity: ctrl ? 1 : 0.3 }}>Ctrl</span>\n *       <span style={{ opacity: shift ? 1 : 0.3 }}>Shift</span>\n *       <span style={{ opacity: alt ? 1 : 0.3 }}>Alt</span>\n *     </div>\n *   )\n * }\n * ```\n */\nexport function useKeyHold(key: HeldKey): boolean {\n  const tracker = getKeyStateTracker()\n  const normalizedKey = key.toLowerCase()\n\n  return useStore(tracker.store, (state) =>\n    state.heldKeys.some((heldKey) => heldKey.toLowerCase() === normalizedKey),\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4CA,SAAgB,WAAW,KAAuB;CAChD,MAAM,UAAU,oBAAoB;CACpC,MAAM,gBAAgB,IAAI,aAAa;AAEvC,QAAO,SAAS,QAAQ,QAAQ,UAC9B,MAAM,SAAS,MAAM,YAAY,QAAQ,aAAa,KAAK,cAAc,CAC1E"}
+{"version":3,"file":"useKeyHold.js","names":[],"sources":["../src/useKeyHold.ts"],"sourcesContent":["import { useStore } from '@tanstack/preact-store'\nimport { getKeyStateTracker } from '@tanstack/hotkeys'\nimport type { IndividualKey } from '@tanstack/hotkeys'\n\n/**\n * Preact hook that returns whether a specific key is currently being held.\n *\n * This hook uses `useStore` from `@tanstack/preact-store` to subscribe\n * to the global KeyStateTracker and uses a selector to determine if\n * the specified key is held.\n *\n * @param key - The key to check (e.g., 'Shift', 'Control', 'A')\n * @returns True if the key is currently held down\n *\n * @example\n * ```tsx\n * function ShiftIndicator() {\n *   const isShiftHeld = useKeyHold('Shift')\n *\n *   return (\n *     <div style={{ opacity: isShiftHeld ? 1 : 0.5 }}>\n *       {isShiftHeld ? 'Shift is pressed!' : 'Press Shift'}\n *     </div>\n *   )\n * }\n * ```\n *\n * @example\n * ```tsx\n * function ModifierIndicators() {\n *   const ctrl = useKeyHold('Control')\n *   const shift = useKeyHold('Shift')\n *   const alt = useKeyHold('Alt')\n *\n *   return (\n *     <div>\n *       <span style={{ opacity: ctrl ? 1 : 0.3 }}>Ctrl</span>\n *       <span style={{ opacity: shift ? 1 : 0.3 }}>Shift</span>\n *       <span style={{ opacity: alt ? 1 : 0.3 }}>Alt</span>\n *     </div>\n *   )\n * }\n * ```\n */\nexport function useKeyHold(key: IndividualKey): boolean {\n  const tracker = getKeyStateTracker()\n  const normalizedKey = key.toLowerCase()\n\n  return useStore(tracker.store, (state) =>\n    state.heldKeys.some((heldKey) => heldKey.toLowerCase() === normalizedKey),\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4CA,SAAgB,WAAW,KAA6B;CACtD,MAAM,UAAU,oBAAoB;CACpC,MAAM,gBAAgB,IAAI,aAAa;AAEvC,QAAO,SAAS,QAAQ,QAAQ,UAC9B,MAAM,SAAS,MAAM,YAAY,QAAQ,aAAa,KAAK,cAAc,CAC1E"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/preact-hotkeys",
-  "version": "0.8.3",
+  "version": "0.9.0",
   "description": "Preact adapter for TanStack Hotkeys",
   "author": "Tanner Linsley",
   "license": "MIT",
@@ -40,7 +40,7 @@
   ],
   "dependencies": {
     "@tanstack/preact-store": "^0.11.3",
-    "@tanstack/hotkeys": "0.6.3"
+    "@tanstack/hotkeys": "0.7.0"
   },
   "devDependencies": {
     "@preact/preset-vite": "^2.10.5",

package/src/index.ts

@@ -13,4 +13,5 @@ export * from './useKeyHold'
 export * from './useHotkeySequence'
 export * from './useHotkeySequences'
 export * from './useHotkeyRecorder'
+export * from './useHotkeyRegistrations'
 export * from './useHotkeySequenceRecorder'

package/src/useHotkeyRegistrations.ts

@@ -0,0 +1,45 @@
+import { useStore } from '@tanstack/preact-store'
+import {
+  getHotkeyManager,
+  getSequenceManager,
+  toHotkeyRegistrationView,
+} from '@tanstack/hotkeys'
+import type {
+  HotkeyRegistrationView,
+  SequenceRegistrationView,
+} from '@tanstack/hotkeys'
+
+/**
+ * Return type for useHotkeyRegistrations.
+ */
+export interface HotkeyRegistrationsResult {
+  /** All registered hotkeys (public view, no callbacks) */
+  hotkeys: Array<HotkeyRegistrationView>
+  /** All registered sequences */
+  sequences: Array<SequenceRegistrationView>
+}
+
+/**
+ * Preact hook that reactively reads all hotkey and sequence registrations
+ * from the singleton managers.
+ *
+ * This is a standalone hook that does NOT require the HotkeysProvider.
+ * It subscribes to both HotkeyManager and SequenceManager stores and
+ * re-renders when registrations change.
+ *
+ * @returns Object with `hotkeys` and `sequences` arrays
+ */
+export function useHotkeyRegistrations(): HotkeyRegistrationsResult {
+  const hotkeyManager = getHotkeyManager()
+  const sequenceManager = getSequenceManager()
+
+  const hotkeys = useStore(hotkeyManager.registrations, (state) =>
+    Array.from(state.values()).map(toHotkeyRegistrationView),
+  )
+
+  const sequences = useStore(sequenceManager.registrations, (state) =>
+    Array.from(state.values()),
+  )
+
+  return { hotkeys, sequences }
+}

package/src/useKeyHold.ts

@@ -1,6 +1,6 @@
 import { useStore } from '@tanstack/preact-store'
 import { getKeyStateTracker } from '@tanstack/hotkeys'
-import type { HeldKey } from '@tanstack/hotkeys'
+import type { IndividualKey } from '@tanstack/hotkeys'
 
 /**
  * Preact hook that returns whether a specific key is currently being held.
@@ -42,7 +42,7 @@ import type { HeldKey } from '@tanstack/hotkeys'
  * }
  * ```
  */
-export function useKeyHold(key: HeldKey): boolean {
+export function useKeyHold(key: IndividualKey): boolean {
   const tracker = getKeyStateTracker()
   const normalizedKey = key.toLowerCase()