@tanstack/solid-hotkeys 0.10.0 → 0.11.0

package/README.md

@@ -1,5 +1,19 @@
 <div align="center">
-  <img src="./media/header_hotkeys.png" alt="TanStack Hotkeys" />
+  <picture>
+    <source
+      media="(prefers-color-scheme: dark)"
+      srcset="https://tanstack.com/api/readme/hotkeys.png?theme=dark"
+    />
+    <source
+      media="(prefers-color-scheme: light)"
+      srcset="https://tanstack.com/api/readme/hotkeys.png"
+    />
+    <img
+      src="https://tanstack.com/api/readme/hotkeys.png"
+      alt="TanStack Hotkeys"
+      width="900"
+    />
+  </picture>
 </div>
 
 <br />

package/dist/createHotkeyHint.cjs

@@ -0,0 +1,20 @@
+let _tanstack_hotkeys = require("@tanstack/hotkeys");
+let solid_js = require("solid-js");
+let _tanstack_solid_store = require("@tanstack/solid-store");
+
+//#region src/createHotkeyHint.ts
+/**
+* Returns a boolean accessor indicating whether held modifiers reveal this shortcut.
+* Pass accessors to track changing bindings and options.
+* Uses the nonempty-subset/AltGr rules of `matchesHeldModifiers`; `exact` requires
+* every modifier. Combine with the action's enabled state before showing a badge.
+* This helper does not register a shortcut or check whether its target is focused.
+*/
+function createHotkeyHint(hotkey, options = {}) {
+	const held = (0, _tanstack_solid_store.useSelector)((0, _tanstack_hotkeys.getKeyStateTracker)().store, (state) => state.heldKeys);
+	return (0, solid_js.createMemo)(() => (0, _tanstack_hotkeys.matchesHeldModifiers)(typeof hotkey === "function" ? hotkey() : hotkey, held(), typeof options === "function" ? options() : options));
+}
+
+//#endregion
+exports.createHotkeyHint = createHotkeyHint;
+//# sourceMappingURL=createHotkeyHint.cjs.map

package/dist/createHotkeyHint.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"createHotkeyHint.cjs","names":[],"sources":["../src/createHotkeyHint.ts"],"sourcesContent":["import { createMemo } from 'solid-js'\nimport { useSelector } from '@tanstack/solid-store'\nimport { getKeyStateTracker, matchesHeldModifiers } from '@tanstack/hotkeys'\nimport type { HeldModifierOptions, RegisterableHotkey } from '@tanstack/hotkeys'\n\n/**\n * Returns a boolean accessor indicating whether held modifiers reveal this shortcut.\n * Pass accessors to track changing bindings and options.\n * Uses the nonempty-subset/AltGr rules of `matchesHeldModifiers`; `exact` requires\n * every modifier. Combine with the action's enabled state before showing a badge.\n * This helper does not register a shortcut or check whether its target is focused.\n */\nexport function createHotkeyHint(\n  hotkey: RegisterableHotkey | (() => RegisterableHotkey),\n  options: HeldModifierOptions | (() => HeldModifierOptions) = {},\n): () => boolean {\n  const held = useSelector(\n    getKeyStateTracker().store,\n    (state) => state.heldKeys,\n  )\n  return createMemo(() =>\n    matchesHeldModifiers(\n      typeof hotkey === 'function' ? hotkey() : hotkey,\n      held(),\n      typeof options === 'function' ? options() : options,\n    ),\n  )\n}\n"],"mappings":";;;;;;;;;;;;AAYA,SAAgB,iBACd,QACA,UAA6D,EAAE,EAChD;CACf,MAAM,yFACgB,CAAC,QACpB,UAAU,MAAM,SAClB;AACD,mFAEI,OAAO,WAAW,aAAa,QAAQ,GAAG,QAC1C,MAAM,EACN,OAAO,YAAY,aAAa,SAAS,GAAG,QAC7C,CACF"}

package/dist/createHotkeyHint.d.cts

@@ -0,0 +1,14 @@
+import { HeldModifierOptions, RegisterableHotkey } from "@tanstack/hotkeys";
+
+//#region src/createHotkeyHint.d.ts
+/**
+ * Returns a boolean accessor indicating whether held modifiers reveal this shortcut.
+ * Pass accessors to track changing bindings and options.
+ * Uses the nonempty-subset/AltGr rules of `matchesHeldModifiers`; `exact` requires
+ * every modifier. Combine with the action's enabled state before showing a badge.
+ * This helper does not register a shortcut or check whether its target is focused.
+ */
+declare function createHotkeyHint(hotkey: RegisterableHotkey | (() => RegisterableHotkey), options?: HeldModifierOptions | (() => HeldModifierOptions)): () => boolean;
+//#endregion
+export { createHotkeyHint };
+//# sourceMappingURL=createHotkeyHint.d.cts.map

package/dist/createHotkeyHint.d.ts

@@ -0,0 +1,14 @@
+import { HeldModifierOptions, RegisterableHotkey } from "@tanstack/hotkeys";
+
+//#region src/createHotkeyHint.d.ts
+/**
+ * Returns a boolean accessor indicating whether held modifiers reveal this shortcut.
+ * Pass accessors to track changing bindings and options.
+ * Uses the nonempty-subset/AltGr rules of `matchesHeldModifiers`; `exact` requires
+ * every modifier. Combine with the action's enabled state before showing a badge.
+ * This helper does not register a shortcut or check whether its target is focused.
+ */
+declare function createHotkeyHint(hotkey: RegisterableHotkey | (() => RegisterableHotkey), options?: HeldModifierOptions | (() => HeldModifierOptions)): () => boolean;
+//#endregion
+export { createHotkeyHint };
+//# sourceMappingURL=createHotkeyHint.d.ts.map

package/dist/createHotkeyHint.js

@@ -0,0 +1,20 @@
+import { getKeyStateTracker, matchesHeldModifiers } from "@tanstack/hotkeys";
+import { createMemo } from "solid-js";
+import { useSelector } from "@tanstack/solid-store";
+
+//#region src/createHotkeyHint.ts
+/**
+* Returns a boolean accessor indicating whether held modifiers reveal this shortcut.
+* Pass accessors to track changing bindings and options.
+* Uses the nonempty-subset/AltGr rules of `matchesHeldModifiers`; `exact` requires
+* every modifier. Combine with the action's enabled state before showing a badge.
+* This helper does not register a shortcut or check whether its target is focused.
+*/
+function createHotkeyHint(hotkey, options = {}) {
+	const held = useSelector(getKeyStateTracker().store, (state) => state.heldKeys);
+	return createMemo(() => matchesHeldModifiers(typeof hotkey === "function" ? hotkey() : hotkey, held(), typeof options === "function" ? options() : options));
+}
+
+//#endregion
+export { createHotkeyHint };
+//# sourceMappingURL=createHotkeyHint.js.map

package/dist/createHotkeyHint.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createHotkeyHint.js","names":[],"sources":["../src/createHotkeyHint.ts"],"sourcesContent":["import { createMemo } from 'solid-js'\nimport { useSelector } from '@tanstack/solid-store'\nimport { getKeyStateTracker, matchesHeldModifiers } from '@tanstack/hotkeys'\nimport type { HeldModifierOptions, RegisterableHotkey } from '@tanstack/hotkeys'\n\n/**\n * Returns a boolean accessor indicating whether held modifiers reveal this shortcut.\n * Pass accessors to track changing bindings and options.\n * Uses the nonempty-subset/AltGr rules of `matchesHeldModifiers`; `exact` requires\n * every modifier. Combine with the action's enabled state before showing a badge.\n * This helper does not register a shortcut or check whether its target is focused.\n */\nexport function createHotkeyHint(\n  hotkey: RegisterableHotkey | (() => RegisterableHotkey),\n  options: HeldModifierOptions | (() => HeldModifierOptions) = {},\n): () => boolean {\n  const held = useSelector(\n    getKeyStateTracker().store,\n    (state) => state.heldKeys,\n  )\n  return createMemo(() =>\n    matchesHeldModifiers(\n      typeof hotkey === 'function' ? hotkey() : hotkey,\n      held(),\n      typeof options === 'function' ? options() : options,\n    ),\n  )\n}\n"],"mappings":";;;;;;;;;;;;AAYA,SAAgB,iBACd,QACA,UAA6D,EAAE,EAChD;CACf,MAAM,OAAO,YACX,oBAAoB,CAAC,QACpB,UAAU,MAAM,SAClB;AACD,QAAO,iBACL,qBACE,OAAO,WAAW,aAAa,QAAQ,GAAG,QAC1C,MAAM,EACN,OAAO,YAAY,aAAa,SAAS,GAAG,QAC7C,CACF"}

package/dist/index.cjs

@@ -10,11 +10,13 @@ const require_createHotkeySequences = require('./createHotkeySequences.cjs');
 const require_createHotkeyRecorder = require('./createHotkeyRecorder.cjs');
 const require_createHotkeyRegistrations = require('./createHotkeyRegistrations.cjs');
 const require_createHotkeySequenceRecorder = require('./createHotkeySequenceRecorder.cjs');
+const require_createHotkeyHint = require('./createHotkeyHint.cjs');
 
 exports.HotkeysProvider = require_HotkeysProvider.HotkeysProvider;
 exports.createHeldKeyCodes = require_createHeldKeyCodes.createHeldKeyCodes;
 exports.createHeldKeys = require_createHeldKeys.createHeldKeys;
 exports.createHotkey = require_createHotkey.createHotkey;
+exports.createHotkeyHint = require_createHotkeyHint.createHotkeyHint;
 exports.createHotkeyRecorder = require_createHotkeyRecorder.createHotkeyRecorder;
 exports.createHotkeyRegistrations = require_createHotkeyRegistrations.createHotkeyRegistrations;
 exports.createHotkeySequence = require_createHotkeySequence.createHotkeySequence;

package/dist/index.d.cts

@@ -9,5 +9,6 @@ import { CreateHotkeySequenceDefinition, createHotkeySequences } from "./createH
 import { SolidHotkeyRecorder, createHotkeyRecorder } from "./createHotkeyRecorder.cjs";
 import { HotkeyRegistrationsResult, createHotkeyRegistrations } from "./createHotkeyRegistrations.cjs";
 import { SolidHotkeySequenceRecorder, createHotkeySequenceRecorder } from "./createHotkeySequenceRecorder.cjs";
+import { createHotkeyHint } from "./createHotkeyHint.cjs";
 export * from "@tanstack/hotkeys";
-export { CreateHotkeyDefinition, CreateHotkeyOptions, CreateHotkeySequenceDefinition, CreateHotkeySequenceOptions, HotkeyRegistrationsResult, HotkeysProvider, HotkeysProviderOptions, HotkeysProviderProps, SolidHotkeyRecorder, SolidHotkeySequenceRecorder, createHeldKeyCodes, createHeldKeys, createHotkey, createHotkeyRecorder, createHotkeyRegistrations, createHotkeySequence, createHotkeySequenceRecorder, createHotkeySequences, createHotkeys, createKeyHold, useDefaultHotkeysOptions, useHotkeysContext };
+export { CreateHotkeyDefinition, CreateHotkeyOptions, CreateHotkeySequenceDefinition, CreateHotkeySequenceOptions, HotkeyRegistrationsResult, HotkeysProvider, HotkeysProviderOptions, HotkeysProviderProps, SolidHotkeyRecorder, SolidHotkeySequenceRecorder, createHeldKeyCodes, createHeldKeys, createHotkey, createHotkeyHint, createHotkeyRecorder, createHotkeyRegistrations, createHotkeySequence, createHotkeySequenceRecorder, createHotkeySequences, createHotkeys, createKeyHold, useDefaultHotkeysOptions, useHotkeysContext };

package/dist/index.d.ts

@@ -9,5 +9,6 @@ import { CreateHotkeySequenceDefinition, createHotkeySequences } from "./createH
 import { SolidHotkeyRecorder, createHotkeyRecorder } from "./createHotkeyRecorder.js";
 import { HotkeyRegistrationsResult, createHotkeyRegistrations } from "./createHotkeyRegistrations.js";
 import { SolidHotkeySequenceRecorder, createHotkeySequenceRecorder } from "./createHotkeySequenceRecorder.js";
+import { createHotkeyHint } from "./createHotkeyHint.js";
 export * from "@tanstack/hotkeys";
-export { CreateHotkeyDefinition, CreateHotkeyOptions, CreateHotkeySequenceDefinition, CreateHotkeySequenceOptions, HotkeyRegistrationsResult, HotkeysProvider, HotkeysProviderOptions, HotkeysProviderProps, SolidHotkeyRecorder, SolidHotkeySequenceRecorder, createHeldKeyCodes, createHeldKeys, createHotkey, createHotkeyRecorder, createHotkeyRegistrations, createHotkeySequence, createHotkeySequenceRecorder, createHotkeySequences, createHotkeys, createKeyHold, useDefaultHotkeysOptions, useHotkeysContext };
+export { CreateHotkeyDefinition, CreateHotkeyOptions, CreateHotkeySequenceDefinition, CreateHotkeySequenceOptions, HotkeyRegistrationsResult, HotkeysProvider, HotkeysProviderOptions, HotkeysProviderProps, SolidHotkeyRecorder, SolidHotkeySequenceRecorder, createHeldKeyCodes, createHeldKeys, createHotkey, createHotkeyHint, createHotkeyRecorder, createHotkeyRegistrations, createHotkeySequence, createHotkeySequenceRecorder, createHotkeySequences, createHotkeys, createKeyHold, useDefaultHotkeysOptions, useHotkeysContext };

package/dist/index.js

@@ -9,7 +9,8 @@ import { createHotkeySequences } from "./createHotkeySequences.js";
 import { createHotkeyRecorder } from "./createHotkeyRecorder.js";
 import { createHotkeyRegistrations } from "./createHotkeyRegistrations.js";
 import { createHotkeySequenceRecorder } from "./createHotkeySequenceRecorder.js";
+import { createHotkeyHint } from "./createHotkeyHint.js";
 
 export * from "@tanstack/hotkeys"
 
-export { HotkeysProvider, createHeldKeyCodes, createHeldKeys, createHotkey, createHotkeyRecorder, createHotkeyRegistrations, createHotkeySequence, createHotkeySequenceRecorder, createHotkeySequences, createHotkeys, createKeyHold, useDefaultHotkeysOptions, useHotkeysContext };
+export { HotkeysProvider, createHeldKeyCodes, createHeldKeys, createHotkey, createHotkeyHint, createHotkeyRecorder, createHotkeyRegistrations, createHotkeySequence, createHotkeySequenceRecorder, createHotkeySequences, createHotkeys, createKeyHold, useDefaultHotkeysOptions, useHotkeysContext };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/solid-hotkeys",
-  "version": "0.10.0",
+  "version": "0.11.0",
   "description": "SolidJS adapter for TanStack Hotkeys",
   "author": "Tanner Linsley",
   "license": "MIT",
@@ -43,7 +43,7 @@
   ],
   "dependencies": {
     "@tanstack/solid-store": "^0.11.0",
-    "@tanstack/hotkeys": "0.8.0"
+    "@tanstack/hotkeys": "0.9.0"
   },
   "devDependencies": {
     "@solidjs/testing-library": "^0.8.10",

package/src/createHotkeyHint.ts

@@ -0,0 +1,28 @@
+import { createMemo } from 'solid-js'
+import { useSelector } from '@tanstack/solid-store'
+import { getKeyStateTracker, matchesHeldModifiers } from '@tanstack/hotkeys'
+import type { HeldModifierOptions, RegisterableHotkey } from '@tanstack/hotkeys'
+
+/**
+ * Returns a boolean accessor indicating whether held modifiers reveal this shortcut.
+ * Pass accessors to track changing bindings and options.
+ * Uses the nonempty-subset/AltGr rules of `matchesHeldModifiers`; `exact` requires
+ * every modifier. Combine with the action's enabled state before showing a badge.
+ * This helper does not register a shortcut or check whether its target is focused.
+ */
+export function createHotkeyHint(
+  hotkey: RegisterableHotkey | (() => RegisterableHotkey),
+  options: HeldModifierOptions | (() => HeldModifierOptions) = {},
+): () => boolean {
+  const held = useSelector(
+    getKeyStateTracker().store,
+    (state) => state.heldKeys,
+  )
+  return createMemo(() =>
+    matchesHeldModifiers(
+      typeof hotkey === 'function' ? hotkey() : hotkey,
+      held(),
+      typeof options === 'function' ? options() : options,
+    ),
+  )
+}

package/src/index.ts

@@ -15,3 +15,4 @@ export * from './createHotkeySequences'
 export * from './createHotkeyRecorder'
 export * from './createHotkeyRegistrations'
 export * from './createHotkeySequenceRecorder'
+export * from './createHotkeyHint'