@tanstack/solid-hotkeys 0.16.0 → 0.17.0

package/dist/createHotkeyHint.d.ts

@@ -2,9 +2,10 @@ import { AppHotkey, HeldModifierOptions, RegisterableHotkey } from "@tanstack/ho
 //#region src/createHotkeyHint.d.ts
 /**
  * Returns an accessor indicating whether held modifiers reveal this shortcut.
- * A sequence reveals its hint from its first step, and an app hotkey uses its
- * effective hotkey (false while unbound). This helper does not register a
- * shortcut or check whether its target is focused.
+ * The hint shows only while the hotkey can fire: some registration of it is
+ * enabled and in an active scope. A sequence reveals its hint from its first
+ * step, and an app hotkey matches its registrations by id and uses its
+ * effective hotkey (false while unbound). This helper does not register a shortcut. A hotkey on an element counts only while focus is inside it.
  */
 export declare function createHotkeyHint(hotkey: RegisterableHotkey | AppHotkey | (() => RegisterableHotkey | AppHotkey), options?: HeldModifierOptions | (() => HeldModifierOptions)): () => boolean;
 //#endregion

package/dist/createHotkeyHint.js

@@ -1,23 +1,26 @@
 import { useAppHotkeysStoreSource } from "./defaultOptions.js";
-import { getKeyStateTracker, isAppHotkey, matchesHeldModifiers, resolveAppHotkey } from "@tanstack/hotkeys";
+import { getHotkeyManager, getKeyStateTracker, isAppHotkey, matchesHeldModifiers, resolveAppHotkey } from "@tanstack/hotkeys";
 import { createMemo } from "solid-js";
 import { useSelector } from "@tanstack/solid-store";
 
 //#region src/createHotkeyHint.ts
 /**
 * Returns an accessor indicating whether held modifiers reveal this shortcut.
-* A sequence reveals its hint from its first step, and an app hotkey uses its
-* effective hotkey (false while unbound). This helper does not register a
-* shortcut or check whether its target is focused.
+* The hint shows only while the hotkey can fire: some registration of it is
+* enabled and in an active scope. A sequence reveals its hint from its first
+* step, and an app hotkey matches its registrations by id and uses its
+* effective hotkey (false while unbound). This helper does not register a shortcut. A hotkey on an element counts only while focus is inside it.
 */
 function createHotkeyHint(hotkey, options = {}) {
 	const appHotkeys = useAppHotkeysStoreSource();
+	const manager = getHotkeyManager();
+	const registrations = useSelector(manager.registrations, (state) => state);
 	const held = useSelector(getKeyStateTracker().store, (state) => state.heldKeys);
 	return createMemo(() => {
 		appHotkeys.state();
 		const value = typeof hotkey === "function" ? hotkey() : hotkey;
 		const resolved = isAppHotkey(value) ? resolveAppHotkey(value, appHotkeys.store).hotkey : value;
-		return resolved !== null && matchesHeldModifiers(resolved, held(), typeof options === "function" ? options() : options);
+		return resolved !== null && matchesHeldModifiers(resolved, held(), typeof options === "function" ? options() : options) && registrations().size > 0 && manager.hasActiveRegistration(value);
 	});
 }
 

package/dist/createHotkeyScopesState.d.ts

@@ -0,0 +1,24 @@
+import { HotkeyScopesState } from "@tanstack/hotkeys";
+//#region src/createHotkeyScopesState.d.ts
+/**
+ * SolidJS primitive that returns a signal of the hotkey manager's scope state:
+ * the active scopes, the exclusive scope that owns the keyboard, and the
+ * scopes it allows or suspends. Updates when scopes activate or release.
+ *
+ * @returns Signal accessor for the current scope state
+ *
+ * @example
+ * ```tsx
+ * function KeyboardOwner() {
+ *   const scopes = createHotkeyScopesState()
+ *
+ *   return (
+ *     <Show when={scopes().exclusive}>
+ *       {(exclusive) => <p>Shortcuts belong to {exclusive()}</p>}
+ *     </Show>
+ *   )
+ * }
+ * ```
+ */
+export declare function createHotkeyScopesState(): () => HotkeyScopesState;
+//#endregion

package/dist/createHotkeyScopesState.js

@@ -0,0 +1,30 @@
+import { getHotkeyManager } from "@tanstack/hotkeys";
+import { useSelector } from "@tanstack/solid-store";
+
+//#region src/createHotkeyScopesState.ts
+/**
+* SolidJS primitive that returns a signal of the hotkey manager's scope state:
+* the active scopes, the exclusive scope that owns the keyboard, and the
+* scopes it allows or suspends. Updates when scopes activate or release.
+*
+* @returns Signal accessor for the current scope state
+*
+* @example
+* ```tsx
+* function KeyboardOwner() {
+*   const scopes = createHotkeyScopesState()
+*
+*   return (
+*     <Show when={scopes().exclusive}>
+*       {(exclusive) => <p>Shortcuts belong to {exclusive()}</p>}
+*     </Show>
+*   )
+* }
+* ```
+*/
+function createHotkeyScopesState() {
+	return useSelector(getHotkeyManager().scopes, (state) => state);
+}
+
+//#endregion
+export { createHotkeyScopesState };

package/dist/index.d.ts

@@ -3,10 +3,11 @@ import { HotkeysProvider, HotkeysProviderOptions, HotkeysProviderProps, useDefau
 import { CreateHotkeyDefinition, createHotkeys } from "./createHotkeys.js";
 import { SolidHotkeyRecorder, createHotkeyRecorder } from "./createHotkeyRecorder.js";
 import { createHotkeyRegistrations } from "./createHotkeyRegistrations.js";
+import { createHotkeyScopesState } from "./createHotkeyScopesState.js";
 import { createHotkeyHint } from "./createHotkeyHint.js";
 import { UseCustomHotkeysResult, createAppHotkeyList, useAppHotkeys, useCustomHotkeys } from "./appHotkeys.js";
 import { createHeldKeys } from "./createHeldKeys.js";
 import { createHeldKeyCodes } from "./createHeldKeyCodes.js";
 import { createKeyHold } from "./createKeyHold.js";
 export * from "@tanstack/hotkeys";
-export { CreateAppHotkeyOptions, CreateHotkeyChordOptions, CreateHotkeyCommonOptions, CreateHotkeyDefinition, CreateHotkeyOptions, CreateHotkeyOptionsFor, CreateHotkeySequenceOptions, CreateHotkeyTarget, HotkeysProvider, HotkeysProviderOptions, HotkeysProviderProps, SolidHotkeyRecorder, UseCustomHotkeysResult, createAppHotkeyList, createHeldKeyCodes, createHeldKeys, createHotkey, createHotkeyHint, createHotkeyRecorder, createHotkeyRegistrations, createHotkeys, createKeyHold, useAppHotkeys, useCustomHotkeys, useDefaultHotkeysOptions, useHotkeysContext };
+export { CreateAppHotkeyOptions, CreateHotkeyChordOptions, CreateHotkeyCommonOptions, CreateHotkeyDefinition, CreateHotkeyOptions, CreateHotkeyOptionsFor, CreateHotkeySequenceOptions, CreateHotkeyTarget, HotkeysProvider, HotkeysProviderOptions, HotkeysProviderProps, SolidHotkeyRecorder, UseCustomHotkeysResult, createAppHotkeyList, createHeldKeyCodes, createHeldKeys, createHotkey, createHotkeyHint, createHotkeyRecorder, createHotkeyRegistrations, createHotkeyScopesState, createHotkeys, createKeyHold, useAppHotkeys, useCustomHotkeys, useDefaultHotkeysOptions, useHotkeysContext };

package/dist/index.js

@@ -3,6 +3,7 @@ import { createHotkeys } from "./createHotkeys.js";
 import { createHotkey } from "./createHotkey.js";
 import { createHotkeyRecorder } from "./createHotkeyRecorder.js";
 import { createHotkeyRegistrations } from "./createHotkeyRegistrations.js";
+import { createHotkeyScopesState } from "./createHotkeyScopesState.js";
 import { createHotkeyHint } from "./createHotkeyHint.js";
 import { createAppHotkeyList, useAppHotkeys, useCustomHotkeys } from "./appHotkeys.js";
 import { createHeldKeys } from "./createHeldKeys.js";
@@ -11,4 +12,4 @@ import { createKeyHold } from "./createKeyHold.js";
 
 export * from "@tanstack/hotkeys"
 
-export { HotkeysProvider, createAppHotkeyList, createHeldKeyCodes, createHeldKeys, createHotkey, createHotkeyHint, createHotkeyRecorder, createHotkeyRegistrations, createHotkeys, createKeyHold, useAppHotkeys, useCustomHotkeys, useDefaultHotkeysOptions, useHotkeysContext };
+export { HotkeysProvider, createAppHotkeyList, createHeldKeyCodes, createHeldKeys, createHotkey, createHotkeyHint, createHotkeyRecorder, createHotkeyRegistrations, createHotkeyScopesState, createHotkeys, createKeyHold, useAppHotkeys, useCustomHotkeys, useDefaultHotkeysOptions, useHotkeysContext };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/solid-hotkeys",
-  "version": "0.16.0",
+  "version": "0.17.0",
   "description": "SolidJS adapter for TanStack Hotkeys",
   "author": "Tanner Linsley",
   "license": "MIT",
@@ -38,7 +38,7 @@
     "skills"
   ],
   "dependencies": {
-    "@tanstack/hotkeys": "0.17.0",
+    "@tanstack/hotkeys": "0.18.0",
     "@tanstack/solid-store": "^0.11.2"
   },
   "devDependencies": {

package/skills/solid-hotkeys/SKILL.md

@@ -54,22 +54,23 @@ export function Editor() {
 
 ## API
 
-| API                                          | What it's for                                                                                                             |
-| -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
-| `createHotkey(hotkey, callback, options?)`   | Register one chord, sequence, or app hotkey for the owning component's lifetime; the hotkey and options can be accessors. |
-| `createHotkeys(definitions, commonOptions?)` | Register several hotkeys, or an accessor of a list built from data, in one call.                                          |
-| `<HotkeysProvider>`                          | Set default options, a scope (`exclusive` for dialogs), `enabled`, and app hotkeys for the components inside it.          |
-| `useHotkeysContext()`                        | Read the nearest provider's merged defaults and enabled state, or `null` outside a provider.                              |
-| `useDefaultHotkeysOptions()`                 | Read the default options merged from every provider above.                                                                |
-| `useAppHotkeys()`                            | Get an accessor of the declared app hotkeys with the user's custom hotkeys applied.                                       |
-| `createAppHotkeyList()`                      | Get an accessor listing every app hotkey with its status, for a cheat sheet or settings screen.                           |
-| `useCustomHotkeys()`                         | Read, change, and reset the user's custom hotkeys, and check a new one for conflicts.                                     |
-| `createHotkeyRecorder(options)`              | Record a chord or sequence the user presses; its state fields are accessors.                                              |
-| `createHotkeyRegistrations()`                | Get an accessor listing every registered hotkey with its options and `meta`.                                              |
-| `createHotkeyHint(hotkey, options?)`         | Get an accessor of whether held modifiers should reveal a shortcut's hint.                                                |
-| `createKeyHold(key)`                         | Get an accessor of whether one key is held.                                                                               |
-| `createHeldKeys()`                           | Get an accessor of every key that's held right now.                                                                       |
-| `createHeldKeyCodes()`                       | Get an accessor mapping each held key to its physical `event.code`.                                                       |
+| API                                          | What it's for                                                                                                                                                                                         |
+| -------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `createHotkey(hotkey, callback, options?)`   | Register one chord, sequence, or app hotkey for the owning component's lifetime; the hotkey and options can be accessors.                                                                             |
+| `createHotkeys(definitions, commonOptions?)` | Register several hotkeys, or an accessor of a list built from data, in one call.                                                                                                                      |
+| `<HotkeysProvider>`                          | Set default options, a scope (`exclusive` for dialogs), `enabled`, and app hotkeys for the components inside it.                                                                                      |
+| `useHotkeysContext()`                        | Read the nearest provider's merged defaults and enabled state, or `null` outside a provider.                                                                                                          |
+| `useDefaultHotkeysOptions()`                 | Read the default options merged from every provider above.                                                                                                                                            |
+| `useAppHotkeys()`                            | Get an accessor of the declared app hotkeys with the user's custom hotkeys applied.                                                                                                                   |
+| `createAppHotkeyList()`                      | Get an accessor listing every app hotkey with its status, for a cheat sheet or settings screen.                                                                                                       |
+| `useCustomHotkeys()`                         | Read, change, and reset the user's custom hotkeys, and check a new one for conflicts.                                                                                                                 |
+| `createHotkeyRecorder(options)`              | Record a chord or sequence the user presses; its state fields are accessors.                                                                                                                          |
+| `createHotkeyRegistrations()`                | Get an accessor listing every registered hotkey with its options, `meta`, and `status` (whether it's enabled and in an active scope).                                                                 |
+| `createHotkeyScopesState()`                  | Get an accessor of the active scopes and the exclusive scope that owns the keyboard.                                                                                                                  |
+| `createHotkeyHint(hotkey, options?)`         | Get an accessor of whether held modifiers should reveal a shortcut's hint. False unless a registration of the hotkey can fire: enabled, in an active scope, and with focus inside its element target. |
+| `createKeyHold(key)`                         | Get an accessor of whether one key is held.                                                                                                                                                           |
+| `createHeldKeys()`                           | Get an accessor of every key that's held right now.                                                                                                                                                   |
+| `createHeldKeyCodes()`                       | Get an accessor mapping each held key to its physical `event.code`.                                                                                                                                   |
 
 The package also re-exports `@tanstack/hotkeys`, such as `formatForDisplay`, `matchesKeyboardEvent`, and `defineAppHotkeys`.