@tanstack/ember-hotkeys 0.5.0 → 0.6.0

package/dist/index.d.ts

@@ -7,10 +7,11 @@ import { useHeldKeyCodes } from "./useHeldKeyCodes.js";
 import { useKeyHold } from "./useKeyHold.js";
 import { useHotkeyHint } from "./useHotkeyHint.js";
 import { useHotkeyRegistrations } from "./useHotkeyRegistrations.js";
+import { useHotkeyScopesState } from "./useHotkeyScopesState.js";
 import { useHotkeyRecorder } from "./useHotkeyRecorder.js";
 import { useAppHotkeyList, useAppHotkeys, useCustomHotkeys } from "./useAppHotkeys.js";
 import { ElementHotkeyOptions, OnHotkeys } from "./onHotkeys.js";
 import { OnHotkey } from "./onHotkey.js";
 import { EmberHotkeysScope, createHotkeysScope } from "./createHotkeysScope.js";
 export * from "@tanstack/hotkeys";
-export { DefaultHotkeysOptions, type ElementHotkeyOptions, EmberAppHotkeyList, EmberCustomHotkeys, EmberHotkeyCommonOptions, EmberHotkeyDefinition, EmberHotkeyRecorder, EmberHotkeyState, EmberHotkeyTarget, EmberHotkeysScope, HotkeyRegistrationsResult, type MaybeGetter, createHotkeysScope, OnHotkey as onHotkey, OnHotkeys as onHotkeys, useAppHotkeyList, useAppHotkeys, useCustomHotkeys, useHeldKeyCodes, useHeldKeys, UseHotkey as useHotkey, useHotkeyHint, useHotkeyRecorder, useHotkeyRegistrations, UseHotkeys as useHotkeys, useKeyHold };
+export { DefaultHotkeysOptions, type ElementHotkeyOptions, EmberAppHotkeyList, EmberCustomHotkeys, EmberHotkeyCommonOptions, EmberHotkeyDefinition, EmberHotkeyRecorder, EmberHotkeyState, EmberHotkeyTarget, EmberHotkeysScope, HotkeyRegistrationsResult, type MaybeGetter, createHotkeysScope, OnHotkey as onHotkey, OnHotkeys as onHotkeys, useAppHotkeyList, useAppHotkeys, useCustomHotkeys, useHeldKeyCodes, useHeldKeys, UseHotkey as useHotkey, useHotkeyHint, useHotkeyRecorder, useHotkeyRegistrations, useHotkeyScopesState, UseHotkeys as useHotkeys, useKeyHold };

package/dist/index.js

@@ -5,6 +5,7 @@ import { useHeldKeyCodes } from "./useHeldKeyCodes.js";
 import { useKeyHold } from "./useKeyHold.js";
 import { useHotkeyHint } from "./useHotkeyHint.js";
 import { useHotkeyRegistrations } from "./useHotkeyRegistrations.js";
+import { useHotkeyScopesState } from "./useHotkeyScopesState.js";
 import { useHotkeyRecorder } from "./useHotkeyRecorder.js";
 import { useAppHotkeyList, useAppHotkeys, useCustomHotkeys } from "./useAppHotkeys.js";
 import { OnHotkey } from "./onHotkey.js";
@@ -13,4 +14,4 @@ import { createHotkeysScope } from "./createHotkeysScope.js";
 
 export * from "@tanstack/hotkeys"
 
-export { createHotkeysScope, OnHotkey as onHotkey, OnHotkeys as onHotkeys, useAppHotkeyList, useAppHotkeys, useCustomHotkeys, useHeldKeyCodes, useHeldKeys, UseHotkey as useHotkey, useHotkeyHint, useHotkeyRecorder, useHotkeyRegistrations, UseHotkeys as useHotkeys, useKeyHold };
+export { createHotkeysScope, OnHotkey as onHotkey, OnHotkeys as onHotkeys, useAppHotkeyList, useAppHotkeys, useCustomHotkeys, useHeldKeyCodes, useHeldKeys, UseHotkey as useHotkey, useHotkeyHint, useHotkeyRecorder, useHotkeyRegistrations, useHotkeyScopesState, UseHotkeys as useHotkeys, useKeyHold };

package/dist/useHotkeyHint.d.ts

@@ -4,8 +4,10 @@ import { AppHotkey, HeldModifierOptions, RegisterableHotkey } from "@tanstack/ho
 //#region src/useHotkeyHint.d.ts
 /**
  * Recomputes for held modifiers and tracked changes to the hotkey or options.
- * A sequence reveals its hint from its first step, and an app hotkey uses its
- * effective hotkey (false while unbound).
+ * 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). A hotkey on an element counts only while focus is inside it.
  */
 export declare function useHotkeyHint(owner: object, hotkey: MaybeGetter<RegisterableHotkey | AppHotkey>, options?: MaybeGetter<HeldModifierOptions>): EmberHotkeyState<boolean>;
 //#endregion

package/dist/useHotkeyHint.js

@@ -1,18 +1,22 @@
 import { read, select, trackPublishedAppHotkeys } from "./utils.js";
-import { getKeyStateTracker, isAppHotkey, matchesHeldModifiers, resolveAppHotkey } from "@tanstack/hotkeys";
+import { getHotkeyManager, getKeyStateTracker, isAppHotkey, matchesHeldModifiers, resolveAppHotkey } from "@tanstack/hotkeys";
 
 //#region src/useHotkeyHint.ts
 /**
 * Recomputes for held modifiers and tracked changes to the hotkey or options.
-* A sequence reveals its hint from its first step, and an app hotkey uses its
-* effective hotkey (false while unbound).
+* 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). A hotkey on an element counts only while focus is inside it.
 */
 function useHotkeyHint(owner, hotkey, options = {}) {
 	const appHotkeys = trackPublishedAppHotkeys(owner);
+	const manager = getHotkeyManager();
+	const registrations = select(owner, manager.registrations, (state) => state);
 	return select(owner, getKeyStateTracker().store, (state) => {
 		const value = read(hotkey);
 		const resolved = isAppHotkey(value) ? resolveAppHotkey(value, appHotkeys()).hotkey : value;
-		return resolved !== null && matchesHeldModifiers(resolved, state.heldKeys, read(options));
+		return resolved !== null && matchesHeldModifiers(resolved, state.heldKeys, read(options)) && registrations.value.size > 0 && manager.hasActiveRegistration(value);
 	});
 }
 

package/dist/useHotkeyScopesState.d.ts

@@ -0,0 +1,10 @@
+import { EmberHotkeyState } from "./types.js";
+import { HotkeyScopesState } from "@tanstack/hotkeys";
+//#region src/useHotkeyScopesState.d.ts
+/**
+ * Reads the hotkey manager's scope state: the active scopes, the exclusive
+ * scope that owns the keyboard, and the scopes it allows or suspends. Pass the
+ * containing component as owner to release the subscription on destruction.
+ */
+export declare function useHotkeyScopesState(owner: object): EmberHotkeyState<HotkeyScopesState>;
+//#endregion

package/dist/useHotkeyScopesState.js

@@ -0,0 +1,15 @@
+import { select } from "./utils.js";
+import { getHotkeyManager } from "@tanstack/hotkeys";
+
+//#region src/useHotkeyScopesState.ts
+/**
+* Reads the hotkey manager's scope state: the active scopes, the exclusive
+* scope that owns the keyboard, and the scopes it allows or suspends. Pass the
+* containing component as owner to release the subscription on destruction.
+*/
+function useHotkeyScopesState(owner) {
+	return select(owner, getHotkeyManager().scopes, (state) => state);
+}
+
+//#endregion
+export { useHotkeyScopesState };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/ember-hotkeys",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "Ember adapter for TanStack Hotkeys",
   "author": "Tanner Linsley",
   "license": "MIT",
@@ -40,7 +40,7 @@
   ],
   "dependencies": {
     "@embroider/addon-shim": "^1.10.3",
-    "@tanstack/hotkeys": "0.17.0",
+    "@tanstack/hotkeys": "0.18.0",
     "@tanstack/store": "^0.11.2",
     "ember-modifier": "4.2.2"
   },

package/skills/ember-hotkeys/SKILL.md

@@ -54,24 +54,25 @@ export default class Editor extends Component {
 
 ## API
 
-| API                                                 | What it's for                                                                                                  |
-| --------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
-| `{{useHotkey hotkey callback ...options}}`          | Register one chord, sequence, or app hotkey while the template renders the helper.                             |
-| `{{useHotkeys definitions}}`                        | Register several hotkeys, or a list built from data, in one helper.                                            |
-| `{{onHotkey hotkey callback ...options}}`           | Attach a hotkey to the element the modifier is on, so it fires while focus is inside that element.             |
-| `{{onHotkeys definitions}}`                         | Attach several hotkeys to one element.                                                                         |
-| `createHotkeysScope(defaults?)`                     | Create `useHotkey`, `useHotkeys`, `onHotkey`, `onHotkeys`, and `useHotkeyRecorder` that share default options. |
-| `provideAppHotkeys(appHotkeys, options?)`           | Declare app hotkeys and load the user's custom hotkeys before the app boots, since Ember has no provider.      |
-| `getHotkeyManager().activateScope(scope, options?)` | Turn on a scope, such as an exclusive one for a dialog; it returns the function that turns the scope off.      |
-| `useAppHotkeys(this)`                               | Get the declared app hotkeys with the user's custom hotkeys applied.                                           |
-| `useAppHotkeyList(this)`                            | List every app hotkey with its status, for a cheat sheet or settings screen.                                   |
-| `useCustomHotkeys(this)`                            | Read, change, and reset the user's custom hotkeys, and check a new one for conflicts.                          |
-| `useHotkeyRecorder(this, options)`                  | Record a chord or sequence the user presses, for a settings screen.                                            |
-| `useHotkeyRegistrations(this)`                      | Read `.hotkeys`, every registered hotkey with its options and `meta`.                                          |
-| `useHotkeyHint(this, hotkey, options?)`             | Get whether held modifiers should reveal a shortcut's hint.                                                    |
-| `useKeyHold(this, key)`                             | Get whether one key is held.                                                                                   |
-| `useHeldKeys(this)`                                 | Get every key that's held right now.                                                                           |
-| `useHeldKeyCodes(this)`                             | Map each held key to its physical `event.code`.                                                                |
+| API                                                 | What it's for                                                                                                                                                                          |
+| --------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `{{useHotkey hotkey callback ...options}}`          | Register one chord, sequence, or app hotkey while the template renders the helper.                                                                                                     |
+| `{{useHotkeys definitions}}`                        | Register several hotkeys, or a list built from data, in one helper.                                                                                                                    |
+| `{{onHotkey hotkey callback ...options}}`           | Attach a hotkey to the element the modifier is on, so it fires while focus is inside that element.                                                                                     |
+| `{{onHotkeys definitions}}`                         | Attach several hotkeys to one element.                                                                                                                                                 |
+| `createHotkeysScope(defaults?)`                     | Create `useHotkey`, `useHotkeys`, `onHotkey`, `onHotkeys`, and `useHotkeyRecorder` that share default options.                                                                         |
+| `provideAppHotkeys(appHotkeys, options?)`           | Declare app hotkeys and load the user's custom hotkeys before the app boots, since Ember has no provider.                                                                              |
+| `getHotkeyManager().activateScope(scope, options?)` | Turn on a scope, such as an exclusive one for a dialog; it returns the function that turns the scope off.                                                                              |
+| `useAppHotkeys(this)`                               | Get the declared app hotkeys with the user's custom hotkeys applied.                                                                                                                   |
+| `useAppHotkeyList(this)`                            | List every app hotkey with its status, for a cheat sheet or settings screen.                                                                                                           |
+| `useCustomHotkeys(this)`                            | Read, change, and reset the user's custom hotkeys, and check a new one for conflicts.                                                                                                  |
+| `useHotkeyRecorder(this, options)`                  | Record a chord or sequence the user presses, for a settings screen.                                                                                                                    |
+| `useHotkeyRegistrations(this)`                      | Read `.hotkeys`, every registered hotkey with its options, `meta`, and `status` (whether it's enabled and in an active scope).                                                         |
+| `useHotkeyScopesState(this)`                        | Get the active scopes and the exclusive scope that owns the keyboard.                                                                                                                  |
+| `useHotkeyHint(this, hotkey, options?)`             | Get 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. |
+| `useKeyHold(this, key)`                             | Get whether one key is held.                                                                                                                                                           |
+| `useHeldKeys(this)`                                 | Get every key that's held right now.                                                                                                                                                   |
+| `useHeldKeyCodes(this)`                             | Map each held key to its physical `event.code`.                                                                                                                                        |
 
 The package also re-exports `@tanstack/hotkeys`, such as `formatForDisplay`, `matchesKeyboardEvent`, and `defineAppHotkeys`.