@tanstack/preact-hotkeys 0.3.0

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/solid-hotkeys)
+> - Angular Hotkeys – needs a contributor!
+> - 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/HotkeysProvider.cjs

@@ -0,0 +1,26 @@
+let preact = require("preact");
+let preact_hooks = require("preact/hooks");
+let preact_jsx_runtime = require("preact/jsx-runtime");
+
+//#region src/HotkeysProvider.tsx
+const HotkeysContext = (0, preact.createContext)(null);
+const DEFAULT_OPTIONS = {};
+function HotkeysProvider({ children, defaultOptions = DEFAULT_OPTIONS }) {
+	const contextValue = (0, preact_hooks.useMemo)(() => ({ defaultOptions }), [defaultOptions]);
+	return /* @__PURE__ */ (0, preact_jsx_runtime.jsx)(HotkeysContext.Provider, {
+		value: contextValue,
+		children
+	});
+}
+function useHotkeysContext() {
+	return (0, preact_hooks.useContext)(HotkeysContext);
+}
+function useDefaultHotkeysOptions() {
+	return (0, preact_hooks.useContext)(HotkeysContext)?.defaultOptions ?? {};
+}
+
+//#endregion
+exports.HotkeysProvider = HotkeysProvider;
+exports.useDefaultHotkeysOptions = useDefaultHotkeysOptions;
+exports.useHotkeysContext = useHotkeysContext;
+//# sourceMappingURL=HotkeysProvider.cjs.map

package/dist/HotkeysProvider.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"HotkeysProvider.cjs","names":[],"sources":["../src/HotkeysProvider.tsx"],"sourcesContent":["import { createContext } from 'preact'\nimport { useContext, useMemo } from 'preact/hooks'\nimport type { ComponentChildren } from 'preact'\nimport type { HotkeyRecorderOptions } from '@tanstack/hotkeys'\nimport type { UseHotkeyOptions } from './useHotkey'\nimport type { UseHotkeySequenceOptions } from './useHotkeySequence'\n\nexport interface HotkeysProviderOptions {\n  hotkey?: Partial<UseHotkeyOptions>\n  hotkeyRecorder?: Partial<HotkeyRecorderOptions>\n  hotkeySequence?: Partial<UseHotkeySequenceOptions>\n}\n\ninterface HotkeysContextValue {\n  defaultOptions: HotkeysProviderOptions\n}\n\nconst HotkeysContext = createContext<HotkeysContextValue | null>(null)\n\nexport interface HotkeysProviderProps {\n  children: ComponentChildren\n  defaultOptions?: HotkeysProviderOptions\n}\n\nconst DEFAULT_OPTIONS: HotkeysProviderOptions = {}\n\nexport function HotkeysProvider({\n  children,\n  defaultOptions = DEFAULT_OPTIONS,\n}: HotkeysProviderProps) {\n  const contextValue: HotkeysContextValue = useMemo(\n    () => ({\n      defaultOptions,\n    }),\n    [defaultOptions],\n  )\n\n  return (\n    <HotkeysContext.Provider value={contextValue}>\n      {children}\n    </HotkeysContext.Provider>\n  )\n}\n\nexport function useHotkeysContext() {\n  return useContext(HotkeysContext)\n}\n\nexport function useDefaultHotkeysOptions() {\n  const context = useContext(HotkeysContext)\n  return context?.defaultOptions ?? {}\n}\n"],"mappings":";;;;;AAiBA,MAAM,2CAA2D,KAAK;AAOtE,MAAM,kBAA0C,EAAE;AAElD,SAAgB,gBAAgB,EAC9B,UACA,iBAAiB,mBACM;CACvB,MAAM,gDACG,EACL,gBACD,GACD,CAAC,eAAe,CACjB;AAED,QACE,4CAAC,eAAe;EAAS,OAAO;EAC7B;GACuB;;AAI9B,SAAgB,oBAAoB;AAClC,qCAAkB,eAAe;;AAGnC,SAAgB,2BAA2B;AAEzC,qCAD2B,eAAe,EAC1B,kBAAkB,EAAE"}

package/dist/HotkeysProvider.d.cts

@@ -0,0 +1,28 @@
+import { UseHotkeyOptions } from "./useHotkey.cjs";
+import { UseHotkeySequenceOptions } from "./useHotkeySequence.cjs";
+import { HotkeyRecorderOptions } from "@tanstack/hotkeys";
+import * as preact from "preact";
+import { ComponentChildren } from "preact";
+
+//#region src/HotkeysProvider.d.ts
+interface HotkeysProviderOptions {
+  hotkey?: Partial<UseHotkeyOptions>;
+  hotkeyRecorder?: Partial<HotkeyRecorderOptions>;
+  hotkeySequence?: Partial<UseHotkeySequenceOptions>;
+}
+interface HotkeysContextValue {
+  defaultOptions: HotkeysProviderOptions;
+}
+interface HotkeysProviderProps {
+  children: ComponentChildren;
+  defaultOptions?: HotkeysProviderOptions;
+}
+declare function HotkeysProvider({
+  children,
+  defaultOptions
+}: HotkeysProviderProps): preact.JSX.Element;
+declare function useHotkeysContext(): HotkeysContextValue | null;
+declare function useDefaultHotkeysOptions(): HotkeysProviderOptions;
+//#endregion
+export { HotkeysProvider, HotkeysProviderOptions, HotkeysProviderProps, useDefaultHotkeysOptions, useHotkeysContext };
+//# sourceMappingURL=HotkeysProvider.d.cts.map

package/dist/HotkeysProvider.d.ts

@@ -0,0 +1,28 @@
+import { UseHotkeyOptions } from "./useHotkey.js";
+import { UseHotkeySequenceOptions } from "./useHotkeySequence.js";
+import { HotkeyRecorderOptions } from "@tanstack/hotkeys";
+import * as preact from "preact";
+import { ComponentChildren } from "preact";
+
+//#region src/HotkeysProvider.d.ts
+interface HotkeysProviderOptions {
+  hotkey?: Partial<UseHotkeyOptions>;
+  hotkeyRecorder?: Partial<HotkeyRecorderOptions>;
+  hotkeySequence?: Partial<UseHotkeySequenceOptions>;
+}
+interface HotkeysContextValue {
+  defaultOptions: HotkeysProviderOptions;
+}
+interface HotkeysProviderProps {
+  children: ComponentChildren;
+  defaultOptions?: HotkeysProviderOptions;
+}
+declare function HotkeysProvider({
+  children,
+  defaultOptions
+}: HotkeysProviderProps): preact.JSX.Element;
+declare function useHotkeysContext(): HotkeysContextValue | null;
+declare function useDefaultHotkeysOptions(): HotkeysProviderOptions;
+//#endregion
+export { HotkeysProvider, HotkeysProviderOptions, HotkeysProviderProps, useDefaultHotkeysOptions, useHotkeysContext };
+//# sourceMappingURL=HotkeysProvider.d.ts.map

package/dist/HotkeysProvider.js

@@ -0,0 +1,24 @@
+import { createContext } from "preact";
+import { useContext, useMemo } from "preact/hooks";
+import { jsx } from "preact/jsx-runtime";
+
+//#region src/HotkeysProvider.tsx
+const HotkeysContext = createContext(null);
+const DEFAULT_OPTIONS = {};
+function HotkeysProvider({ children, defaultOptions = DEFAULT_OPTIONS }) {
+	const contextValue = useMemo(() => ({ defaultOptions }), [defaultOptions]);
+	return /* @__PURE__ */ jsx(HotkeysContext.Provider, {
+		value: contextValue,
+		children
+	});
+}
+function useHotkeysContext() {
+	return useContext(HotkeysContext);
+}
+function useDefaultHotkeysOptions() {
+	return useContext(HotkeysContext)?.defaultOptions ?? {};
+}
+
+//#endregion
+export { HotkeysProvider, useDefaultHotkeysOptions, useHotkeysContext };
+//# sourceMappingURL=HotkeysProvider.js.map

package/dist/HotkeysProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HotkeysProvider.js","names":[],"sources":["../src/HotkeysProvider.tsx"],"sourcesContent":["import { createContext } from 'preact'\nimport { useContext, useMemo } from 'preact/hooks'\nimport type { ComponentChildren } from 'preact'\nimport type { HotkeyRecorderOptions } from '@tanstack/hotkeys'\nimport type { UseHotkeyOptions } from './useHotkey'\nimport type { UseHotkeySequenceOptions } from './useHotkeySequence'\n\nexport interface HotkeysProviderOptions {\n  hotkey?: Partial<UseHotkeyOptions>\n  hotkeyRecorder?: Partial<HotkeyRecorderOptions>\n  hotkeySequence?: Partial<UseHotkeySequenceOptions>\n}\n\ninterface HotkeysContextValue {\n  defaultOptions: HotkeysProviderOptions\n}\n\nconst HotkeysContext = createContext<HotkeysContextValue | null>(null)\n\nexport interface HotkeysProviderProps {\n  children: ComponentChildren\n  defaultOptions?: HotkeysProviderOptions\n}\n\nconst DEFAULT_OPTIONS: HotkeysProviderOptions = {}\n\nexport function HotkeysProvider({\n  children,\n  defaultOptions = DEFAULT_OPTIONS,\n}: HotkeysProviderProps) {\n  const contextValue: HotkeysContextValue = useMemo(\n    () => ({\n      defaultOptions,\n    }),\n    [defaultOptions],\n  )\n\n  return (\n    <HotkeysContext.Provider value={contextValue}>\n      {children}\n    </HotkeysContext.Provider>\n  )\n}\n\nexport function useHotkeysContext() {\n  return useContext(HotkeysContext)\n}\n\nexport function useDefaultHotkeysOptions() {\n  const context = useContext(HotkeysContext)\n  return context?.defaultOptions ?? {}\n}\n"],"mappings":";;;;;AAiBA,MAAM,iBAAiB,cAA0C,KAAK;AAOtE,MAAM,kBAA0C,EAAE;AAElD,SAAgB,gBAAgB,EAC9B,UACA,iBAAiB,mBACM;CACvB,MAAM,eAAoC,eACjC,EACL,gBACD,GACD,CAAC,eAAe,CACjB;AAED,QACE,oBAAC,eAAe;EAAS,OAAO;EAC7B;GACuB;;AAI9B,SAAgB,oBAAoB;AAClC,QAAO,WAAW,eAAe;;AAGnC,SAAgB,2BAA2B;AAEzC,QADgB,WAAW,eAAe,EAC1B,kBAAkB,EAAE"}

package/dist/index.cjs

@@ -0,0 +1,25 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+const require_HotkeysProvider = require('./HotkeysProvider.cjs');
+const require_useHotkey = require('./useHotkey.cjs');
+const require_useHeldKeys = require('./useHeldKeys.cjs');
+const require_useHeldKeyCodes = require('./useHeldKeyCodes.cjs');
+const require_useKeyHold = require('./useKeyHold.cjs');
+const require_useHotkeySequence = require('./useHotkeySequence.cjs');
+const require_useHotkeyRecorder = require('./useHotkeyRecorder.cjs');
+
+exports.HotkeysProvider = require_HotkeysProvider.HotkeysProvider;
+exports.useDefaultHotkeysOptions = require_HotkeysProvider.useDefaultHotkeysOptions;
+exports.useHeldKeyCodes = require_useHeldKeyCodes.useHeldKeyCodes;
+exports.useHeldKeys = require_useHeldKeys.useHeldKeys;
+exports.useHotkey = require_useHotkey.useHotkey;
+exports.useHotkeyRecorder = require_useHotkeyRecorder.useHotkeyRecorder;
+exports.useHotkeySequence = require_useHotkeySequence.useHotkeySequence;
+exports.useHotkeysContext = require_HotkeysProvider.useHotkeysContext;
+exports.useKeyHold = require_useKeyHold.useKeyHold;
+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 { UseHotkeyOptions, useHotkey } from "./useHotkey.cjs";
+import { UseHotkeySequenceOptions, useHotkeySequence } from "./useHotkeySequence.cjs";
+import { HotkeysProvider, HotkeysProviderOptions, HotkeysProviderProps, useDefaultHotkeysOptions, useHotkeysContext } from "./HotkeysProvider.cjs";
+import { useHeldKeys } from "./useHeldKeys.cjs";
+import { useHeldKeyCodes } from "./useHeldKeyCodes.cjs";
+import { useKeyHold } from "./useKeyHold.cjs";
+import { PreactHotkeyRecorder, useHotkeyRecorder } from "./useHotkeyRecorder.cjs";
+export * from "@tanstack/hotkeys";
+export { HotkeysProvider, HotkeysProviderOptions, HotkeysProviderProps, PreactHotkeyRecorder, UseHotkeyOptions, UseHotkeySequenceOptions, useDefaultHotkeysOptions, useHeldKeyCodes, useHeldKeys, useHotkey, useHotkeyRecorder, useHotkeySequence, useHotkeysContext, useKeyHold };

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+import { UseHotkeyOptions, useHotkey } from "./useHotkey.js";
+import { UseHotkeySequenceOptions, useHotkeySequence } from "./useHotkeySequence.js";
+import { HotkeysProvider, HotkeysProviderOptions, HotkeysProviderProps, useDefaultHotkeysOptions, useHotkeysContext } from "./HotkeysProvider.js";
+import { useHeldKeys } from "./useHeldKeys.js";
+import { useHeldKeyCodes } from "./useHeldKeyCodes.js";
+import { useKeyHold } from "./useKeyHold.js";
+import { PreactHotkeyRecorder, useHotkeyRecorder } from "./useHotkeyRecorder.js";
+export * from "@tanstack/hotkeys";
+export { HotkeysProvider, HotkeysProviderOptions, HotkeysProviderProps, PreactHotkeyRecorder, UseHotkeyOptions, UseHotkeySequenceOptions, useDefaultHotkeysOptions, useHeldKeyCodes, useHeldKeys, useHotkey, useHotkeyRecorder, useHotkeySequence, useHotkeysContext, useKeyHold };

package/dist/index.js

@@ -0,0 +1,11 @@
+import { HotkeysProvider, useDefaultHotkeysOptions, useHotkeysContext } from "./HotkeysProvider.js";
+import { useHotkey } from "./useHotkey.js";
+import { useHeldKeys } from "./useHeldKeys.js";
+import { useHeldKeyCodes } from "./useHeldKeyCodes.js";
+import { useKeyHold } from "./useKeyHold.js";
+import { useHotkeySequence } from "./useHotkeySequence.js";
+import { useHotkeyRecorder } from "./useHotkeyRecorder.js";
+
+export * from "@tanstack/hotkeys"
+
+export { HotkeysProvider, useDefaultHotkeysOptions, useHeldKeyCodes, useHeldKeys, useHotkey, useHotkeyRecorder, useHotkeySequence, useHotkeysContext, useKeyHold };

package/dist/useHeldKeyCodes.cjs

@@ -0,0 +1,37 @@
+let _tanstack_hotkeys = require("@tanstack/hotkeys");
+let _tanstack_preact_store = require("@tanstack/preact-store");
+
+//#region src/useHeldKeyCodes.ts
+/**
+* Preact hook that returns a map of currently held key names to their physical `event.code` values.
+*
+* This is useful for debugging which physical key was pressed (e.g. distinguishing
+* left vs right Shift via "ShiftLeft" / "ShiftRight").
+*
+* @returns Record mapping normalized key names to their `event.code` values
+*
+* @example
+* ```tsx
+* function KeyDebugDisplay() {
+*   const heldKeys = useHeldKeys()
+*   const heldCodes = useHeldKeyCodes()
+*
+*   return (
+*     <div>
+*       {heldKeys.map((key) => (
+*         <kbd key={key}>
+*           {key} <small>{heldCodes[key]}</small>
+*         </kbd>
+*       ))}
+*     </div>
+*   )
+* }
+* ```
+*/
+function useHeldKeyCodes() {
+	return (0, _tanstack_preact_store.useStore)((0, _tanstack_hotkeys.getKeyStateTracker)().store, (state) => state.heldCodes);
+}
+
+//#endregion
+exports.useHeldKeyCodes = useHeldKeyCodes;
+//# sourceMappingURL=useHeldKeyCodes.cjs.map

package/dist/useHeldKeyCodes.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"useHeldKeyCodes.cjs","names":[],"sources":["../src/useHeldKeyCodes.ts"],"sourcesContent":["import { useStore } from '@tanstack/preact-store'\nimport { getKeyStateTracker } from '@tanstack/hotkeys'\n\n/**\n * Preact hook that returns a map of currently held key names to their physical `event.code` values.\n *\n * This is useful for debugging which physical key was pressed (e.g. distinguishing\n * left vs right Shift via \"ShiftLeft\" / \"ShiftRight\").\n *\n * @returns Record mapping normalized key names to their `event.code` values\n *\n * @example\n * ```tsx\n * function KeyDebugDisplay() {\n *   const heldKeys = useHeldKeys()\n *   const heldCodes = useHeldKeyCodes()\n *\n *   return (\n *     <div>\n *       {heldKeys.map((key) => (\n *         <kbd key={key}>\n *           {key} <small>{heldCodes[key]}</small>\n *         </kbd>\n *       ))}\n *     </div>\n *   )\n * }\n * ```\n */\nexport function useHeldKeyCodes(): Record<string, string> {\n  const tracker = getKeyStateTracker()\n  return useStore(tracker.store, (state) => state.heldCodes)\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6BA,SAAgB,kBAA0C;AAExD,wFADoC,CACZ,QAAQ,UAAU,MAAM,UAAU"}

package/dist/useHeldKeyCodes.d.cts

@@ -0,0 +1,31 @@
+//#region src/useHeldKeyCodes.d.ts
+/**
+ * Preact hook that returns a map of currently held key names to their physical `event.code` values.
+ *
+ * This is useful for debugging which physical key was pressed (e.g. distinguishing
+ * left vs right Shift via "ShiftLeft" / "ShiftRight").
+ *
+ * @returns Record mapping normalized key names to their `event.code` values
+ *
+ * @example
+ * ```tsx
+ * function KeyDebugDisplay() {
+ *   const heldKeys = useHeldKeys()
+ *   const heldCodes = useHeldKeyCodes()
+ *
+ *   return (
+ *     <div>
+ *       {heldKeys.map((key) => (
+ *         <kbd key={key}>
+ *           {key} <small>{heldCodes[key]}</small>
+ *         </kbd>
+ *       ))}
+ *     </div>
+ *   )
+ * }
+ * ```
+ */
+declare function useHeldKeyCodes(): Record<string, string>;
+//#endregion
+export { useHeldKeyCodes };
+//# sourceMappingURL=useHeldKeyCodes.d.cts.map

package/dist/useHeldKeyCodes.d.ts

@@ -0,0 +1,31 @@
+//#region src/useHeldKeyCodes.d.ts
+/**
+ * Preact hook that returns a map of currently held key names to their physical `event.code` values.
+ *
+ * This is useful for debugging which physical key was pressed (e.g. distinguishing
+ * left vs right Shift via "ShiftLeft" / "ShiftRight").
+ *
+ * @returns Record mapping normalized key names to their `event.code` values
+ *
+ * @example
+ * ```tsx
+ * function KeyDebugDisplay() {
+ *   const heldKeys = useHeldKeys()
+ *   const heldCodes = useHeldKeyCodes()
+ *
+ *   return (
+ *     <div>
+ *       {heldKeys.map((key) => (
+ *         <kbd key={key}>
+ *           {key} <small>{heldCodes[key]}</small>
+ *         </kbd>
+ *       ))}
+ *     </div>
+ *   )
+ * }
+ * ```
+ */
+declare function useHeldKeyCodes(): Record<string, string>;
+//#endregion
+export { useHeldKeyCodes };
+//# sourceMappingURL=useHeldKeyCodes.d.ts.map

package/dist/useHeldKeyCodes.js

@@ -0,0 +1,37 @@
+import { getKeyStateTracker } from "@tanstack/hotkeys";
+import { useStore } from "@tanstack/preact-store";
+
+//#region src/useHeldKeyCodes.ts
+/**
+* Preact hook that returns a map of currently held key names to their physical `event.code` values.
+*
+* This is useful for debugging which physical key was pressed (e.g. distinguishing
+* left vs right Shift via "ShiftLeft" / "ShiftRight").
+*
+* @returns Record mapping normalized key names to their `event.code` values
+*
+* @example
+* ```tsx
+* function KeyDebugDisplay() {
+*   const heldKeys = useHeldKeys()
+*   const heldCodes = useHeldKeyCodes()
+*
+*   return (
+*     <div>
+*       {heldKeys.map((key) => (
+*         <kbd key={key}>
+*           {key} <small>{heldCodes[key]}</small>
+*         </kbd>
+*       ))}
+*     </div>
+*   )
+* }
+* ```
+*/
+function useHeldKeyCodes() {
+	return useStore(getKeyStateTracker().store, (state) => state.heldCodes);
+}
+
+//#endregion
+export { useHeldKeyCodes };
+//# sourceMappingURL=useHeldKeyCodes.js.map

package/dist/useHeldKeyCodes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useHeldKeyCodes.js","names":[],"sources":["../src/useHeldKeyCodes.ts"],"sourcesContent":["import { useStore } from '@tanstack/preact-store'\nimport { getKeyStateTracker } from '@tanstack/hotkeys'\n\n/**\n * Preact hook that returns a map of currently held key names to their physical `event.code` values.\n *\n * This is useful for debugging which physical key was pressed (e.g. distinguishing\n * left vs right Shift via \"ShiftLeft\" / \"ShiftRight\").\n *\n * @returns Record mapping normalized key names to their `event.code` values\n *\n * @example\n * ```tsx\n * function KeyDebugDisplay() {\n *   const heldKeys = useHeldKeys()\n *   const heldCodes = useHeldKeyCodes()\n *\n *   return (\n *     <div>\n *       {heldKeys.map((key) => (\n *         <kbd key={key}>\n *           {key} <small>{heldCodes[key]}</small>\n *         </kbd>\n *       ))}\n *     </div>\n *   )\n * }\n * ```\n */\nexport function useHeldKeyCodes(): Record<string, string> {\n  const tracker = getKeyStateTracker()\n  return useStore(tracker.store, (state) => state.heldCodes)\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6BA,SAAgB,kBAA0C;AAExD,QAAO,SADS,oBAAoB,CACZ,QAAQ,UAAU,MAAM,UAAU"}

package/dist/useHeldKeys.cjs

@@ -0,0 +1,33 @@
+let _tanstack_hotkeys = require("@tanstack/hotkeys");
+let _tanstack_preact_store = require("@tanstack/preact-store");
+
+//#region src/useHeldKeys.ts
+/**
+* Preact hook that returns an array of currently held keyboard keys.
+*
+* This hook uses `useStore` from `@tanstack/preact-store` to subscribe
+* to the global KeyStateTracker and updates whenever keys are pressed
+* or released.
+*
+* @returns Array of currently held key names
+*
+* @example
+* ```tsx
+* function KeyDisplay() {
+*   const heldKeys = useHeldKeys()
+*
+*   return (
+*     <div>
+*       Currently pressed: {heldKeys.join(' + ') || 'None'}
+*     </div>
+*   )
+* }
+* ```
+*/
+function useHeldKeys() {
+	return (0, _tanstack_preact_store.useStore)((0, _tanstack_hotkeys.getKeyStateTracker)().store, (state) => state.heldKeys);
+}
+
+//#endregion
+exports.useHeldKeys = useHeldKeys;
+//# sourceMappingURL=useHeldKeys.cjs.map

package/dist/useHeldKeys.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"useHeldKeys.cjs","names":[],"sources":["../src/useHeldKeys.ts"],"sourcesContent":["import { useStore } from '@tanstack/preact-store'\nimport { getKeyStateTracker } from '@tanstack/hotkeys'\n\n/**\n * Preact hook that returns an array of currently held keyboard keys.\n *\n * This hook uses `useStore` from `@tanstack/preact-store` to subscribe\n * to the global KeyStateTracker and updates whenever keys are pressed\n * or released.\n *\n * @returns Array of currently held key names\n *\n * @example\n * ```tsx\n * function KeyDisplay() {\n *   const heldKeys = useHeldKeys()\n *\n *   return (\n *     <div>\n *       Currently pressed: {heldKeys.join(' + ') || 'None'}\n *     </div>\n *   )\n * }\n * ```\n */\nexport function useHeldKeys(): Array<string> {\n  const tracker = getKeyStateTracker()\n  return useStore(tracker.store, (state) => state.heldKeys)\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAyBA,SAAgB,cAA6B;AAE3C,wFADoC,CACZ,QAAQ,UAAU,MAAM,SAAS"}

package/dist/useHeldKeys.d.cts

@@ -0,0 +1,27 @@
+//#region src/useHeldKeys.d.ts
+/**
+ * Preact hook that returns an array of currently held keyboard keys.
+ *
+ * This hook uses `useStore` from `@tanstack/preact-store` to subscribe
+ * to the global KeyStateTracker and updates whenever keys are pressed
+ * or released.
+ *
+ * @returns Array of currently held key names
+ *
+ * @example
+ * ```tsx
+ * function KeyDisplay() {
+ *   const heldKeys = useHeldKeys()
+ *
+ *   return (
+ *     <div>
+ *       Currently pressed: {heldKeys.join(' + ') || 'None'}
+ *     </div>
+ *   )
+ * }
+ * ```
+ */
+declare function useHeldKeys(): Array<string>;
+//#endregion
+export { useHeldKeys };
+//# sourceMappingURL=useHeldKeys.d.cts.map

package/dist/useHeldKeys.d.ts

@@ -0,0 +1,27 @@
+//#region src/useHeldKeys.d.ts
+/**
+ * Preact hook that returns an array of currently held keyboard keys.
+ *
+ * This hook uses `useStore` from `@tanstack/preact-store` to subscribe
+ * to the global KeyStateTracker and updates whenever keys are pressed
+ * or released.
+ *
+ * @returns Array of currently held key names
+ *
+ * @example
+ * ```tsx
+ * function KeyDisplay() {
+ *   const heldKeys = useHeldKeys()
+ *
+ *   return (
+ *     <div>
+ *       Currently pressed: {heldKeys.join(' + ') || 'None'}
+ *     </div>
+ *   )
+ * }
+ * ```
+ */
+declare function useHeldKeys(): Array<string>;
+//#endregion
+export { useHeldKeys };
+//# sourceMappingURL=useHeldKeys.d.ts.map

package/dist/useHeldKeys.js

@@ -0,0 +1,33 @@
+import { getKeyStateTracker } from "@tanstack/hotkeys";
+import { useStore } from "@tanstack/preact-store";
+
+//#region src/useHeldKeys.ts
+/**
+* Preact hook that returns an array of currently held keyboard keys.
+*
+* This hook uses `useStore` from `@tanstack/preact-store` to subscribe
+* to the global KeyStateTracker and updates whenever keys are pressed
+* or released.
+*
+* @returns Array of currently held key names
+*
+* @example
+* ```tsx
+* function KeyDisplay() {
+*   const heldKeys = useHeldKeys()
+*
+*   return (
+*     <div>
+*       Currently pressed: {heldKeys.join(' + ') || 'None'}
+*     </div>
+*   )
+* }
+* ```
+*/
+function useHeldKeys() {
+	return useStore(getKeyStateTracker().store, (state) => state.heldKeys);
+}
+
+//#endregion
+export { useHeldKeys };
+//# sourceMappingURL=useHeldKeys.js.map

package/dist/useHeldKeys.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useHeldKeys.js","names":[],"sources":["../src/useHeldKeys.ts"],"sourcesContent":["import { useStore } from '@tanstack/preact-store'\nimport { getKeyStateTracker } from '@tanstack/hotkeys'\n\n/**\n * Preact hook that returns an array of currently held keyboard keys.\n *\n * This hook uses `useStore` from `@tanstack/preact-store` to subscribe\n * to the global KeyStateTracker and updates whenever keys are pressed\n * or released.\n *\n * @returns Array of currently held key names\n *\n * @example\n * ```tsx\n * function KeyDisplay() {\n *   const heldKeys = useHeldKeys()\n *\n *   return (\n *     <div>\n *       Currently pressed: {heldKeys.join(' + ') || 'None'}\n *     </div>\n *   )\n * }\n * ```\n */\nexport function useHeldKeys(): Array<string> {\n  const tracker = getKeyStateTracker()\n  return useStore(tracker.store, (state) => state.heldKeys)\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAyBA,SAAgB,cAA6B;AAE3C,QAAO,SADS,oBAAoB,CACZ,QAAQ,UAAU,MAAM,SAAS"}