@tanstack/react-hotkeys 0.15.1 → 0.17.0

package/dist/index.d.ts

@@ -3,10 +3,11 @@ import { HotkeysProvider, HotkeysProviderOptions, HotkeysProviderProps, useDefau
 import { UseHotkeyDefinition, useHotkeys } from "./useHotkeys.js";
 import { ReactHotkeyRecorder, useHotkeyRecorder } from "./useHotkeyRecorder.js";
 import { useHotkeyRegistrations } from "./useHotkeyRegistrations.js";
+import { useHotkeyScopesState } from "./useHotkeyScopesState.js";
 import { useHotkeyHint } from "./useHotkeyHint.js";
 import { UseCustomHotkeysResult, useAppHotkeyList, useAppHotkeys, useCustomHotkeys } from "./useAppHotkeys.js";
 import { useHeldKeys } from "./useHeldKeys.js";
 import { useHeldKeyCodes } from "./useHeldKeyCodes.js";
 import { useKeyHold } from "./useKeyHold.js";
 export * from "@tanstack/hotkeys";
-export { HotkeysProvider, HotkeysProviderOptions, HotkeysProviderProps, ReactHotkeyRecorder, UseAppHotkeyOptions, UseCustomHotkeysResult, UseHotkeyChordOptions, UseHotkeyCommonOptions, UseHotkeyDefinition, UseHotkeyOptions, UseHotkeyOptionsFor, UseHotkeySequenceOptions, UseHotkeyTarget, useAppHotkeyList, useAppHotkeys, useCustomHotkeys, useDefaultHotkeysOptions, useHeldKeyCodes, useHeldKeys, useHotkey, useHotkeyHint, useHotkeyRecorder, useHotkeyRegistrations, useHotkeys, useHotkeysContext, useKeyHold };
+export { HotkeysProvider, HotkeysProviderOptions, HotkeysProviderProps, ReactHotkeyRecorder, UseAppHotkeyOptions, UseCustomHotkeysResult, UseHotkeyChordOptions, UseHotkeyCommonOptions, UseHotkeyDefinition, UseHotkeyOptions, UseHotkeyOptionsFor, UseHotkeySequenceOptions, UseHotkeyTarget, useAppHotkeyList, useAppHotkeys, useCustomHotkeys, useDefaultHotkeysOptions, useHeldKeyCodes, useHeldKeys, useHotkey, useHotkeyHint, useHotkeyRecorder, useHotkeyRegistrations, useHotkeyScopesState, useHotkeys, useHotkeysContext, useKeyHold };

package/dist/index.js

@@ -3,6 +3,7 @@ import { useHotkeys } from "./useHotkeys.js";
 import { useHotkey } from "./useHotkey.js";
 import { useHotkeyRecorder } from "./useHotkeyRecorder.js";
 import { useHotkeyRegistrations } from "./useHotkeyRegistrations.js";
+import { useHotkeyScopesState } from "./useHotkeyScopesState.js";
 import { useHotkeyHint } from "./useHotkeyHint.js";
 import { useAppHotkeyList, useAppHotkeys, useCustomHotkeys } from "./useAppHotkeys.js";
 import { useHeldKeys } from "./useHeldKeys.js";
@@ -11,4 +12,4 @@ import { useKeyHold } from "./useKeyHold.js";
 
 export * from "@tanstack/hotkeys"
 
-export { HotkeysProvider, useAppHotkeyList, useAppHotkeys, useCustomHotkeys, useDefaultHotkeysOptions, useHeldKeyCodes, useHeldKeys, useHotkey, useHotkeyHint, useHotkeyRecorder, useHotkeyRegistrations, useHotkeys, useHotkeysContext, useKeyHold };
+export { HotkeysProvider, useAppHotkeyList, useAppHotkeys, useCustomHotkeys, useDefaultHotkeysOptions, useHeldKeyCodes, useHeldKeys, useHotkey, useHotkeyHint, useHotkeyRecorder, useHotkeyRegistrations, useHotkeyScopesState, useHotkeys, useHotkeysContext, useKeyHold };

package/dist/useHotkeyHint.d.ts

@@ -2,12 +2,12 @@ import { AppHotkey, HeldModifierOptions, RegisterableHotkey } from "@tanstack/ho
 //#region src/useHotkeyHint.d.ts
 /**
  * Returns a boolean indicating whether held modifiers reveal this shortcut.
- * Only visibility changes from held-key updates cause a rerender.
- * Uses the nonempty-subset/AltGr rules of `matchesHeldModifiers`; `exact` requires
- * every modifier. A sequence reveals its hint from its first step, and an app
- * hotkey uses its effective hotkey (false while unbound). 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.
+ * The hint shows only while the hotkey can fire: some registration of it is
+ * enabled and in an active scope. An app hotkey matches its registrations by
+ * id and uses its effective hotkey (false while unbound).
+ * Uses the nonempty-subset/AltGr rules of `matchesHeldModifiers`; `exact`
+ * requires every modifier. A sequence reveals its hint from its first step.
+ * Only visibility changes cause a rerender. This helper does not register a shortcut. A hotkey on an element counts only while focus is inside it.
  */
 export declare function useHotkeyHint(hotkey: RegisterableHotkey | AppHotkey, options?: HeldModifierOptions): boolean;
 //#endregion

package/dist/useHotkeyHint.js

@@ -1,21 +1,24 @@
 import { useAppHotkeysStoreState } from "./_appHotkeysStore.js";
-import { getKeyStateTracker, isAppHotkey, matchesHeldModifiers, resolveAppHotkey } from "@tanstack/hotkeys";
+import { getHotkeyManager, getKeyStateTracker, isAppHotkey, matchesHeldModifiers, resolveAppHotkey } from "@tanstack/hotkeys";
 import { useSelector } from "@tanstack/react-store";
 
 //#region src/useHotkeyHint.ts
 /**
 * Returns a boolean indicating whether held modifiers reveal this shortcut.
-* Only visibility changes from held-key updates cause a rerender.
-* Uses the nonempty-subset/AltGr rules of `matchesHeldModifiers`; `exact` requires
-* every modifier. A sequence reveals its hint from its first step, and an app
-* hotkey uses its effective hotkey (false while unbound). 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.
+* The hint shows only while the hotkey can fire: some registration of it is
+* enabled and in an active scope. An app hotkey matches its registrations by
+* id and uses its effective hotkey (false while unbound).
+* Uses the nonempty-subset/AltGr rules of `matchesHeldModifiers`; `exact`
+* requires every modifier. A sequence reveals its hint from its first step.
+* Only visibility changes cause a rerender. This helper does not register a shortcut. A hotkey on an element counts only while focus is inside it.
 */
 function useHotkeyHint(hotkey, options = {}) {
 	const store = useAppHotkeysStoreState();
 	const resolved = isAppHotkey(hotkey) ? resolveAppHotkey(hotkey, store).hotkey : hotkey;
-	return useSelector(getKeyStateTracker().store, (state) => resolved !== null && matchesHeldModifiers(resolved, state.heldKeys, options));
+	const manager = getHotkeyManager();
+	const active = useSelector(manager.registrations, () => resolved !== null && manager.hasActiveRegistration(hotkey));
+	const held = useSelector(getKeyStateTracker().store, (state) => resolved !== null && matchesHeldModifiers(resolved, state.heldKeys, options));
+	return active && held;
 }
 
 //#endregion

package/dist/useHotkeyScopesState.d.ts

@@ -0,0 +1,20 @@
+import { HotkeyScopesState } from "@tanstack/hotkeys";
+//#region src/useHotkeyScopesState.d.ts
+/**
+ * React hook that returns the hotkey manager's scope state: the active
+ * scopes, the exclusive scope that owns the keyboard, and the scopes it
+ * allows or suspends. Re-renders when scopes activate or release.
+ *
+ * @returns The current scope state
+ *
+ * @example
+ * ```tsx
+ * function KeyboardOwner() {
+ *   const { exclusive } = useHotkeyScopesState()
+ *
+ *   return exclusive ? <p>Shortcuts belong to {exclusive}</p> : null
+ * }
+ * ```
+ */
+export declare function useHotkeyScopesState(): HotkeyScopesState;
+//#endregion

package/dist/useHotkeyScopesState.js

@@ -0,0 +1,26 @@
+import { getHotkeyManager } from "@tanstack/hotkeys";
+import { useSelector } from "@tanstack/react-store";
+
+//#region src/useHotkeyScopesState.ts
+/**
+* React hook that returns the hotkey manager's scope state: the active
+* scopes, the exclusive scope that owns the keyboard, and the scopes it
+* allows or suspends. Re-renders when scopes activate or release.
+*
+* @returns The current scope state
+*
+* @example
+* ```tsx
+* function KeyboardOwner() {
+*   const { exclusive } = useHotkeyScopesState()
+*
+*   return exclusive ? <p>Shortcuts belong to {exclusive}</p> : null
+* }
+* ```
+*/
+function useHotkeyScopesState() {
+	return useSelector(getHotkeyManager().scopes, (state) => state);
+}
+
+//#endregion
+export { useHotkeyScopesState };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/react-hotkeys",
-  "version": "0.15.1",
+  "version": "0.17.0",
   "description": "React adapter for TanStack Hotkeys",
   "author": "Tanner Linsley",
   "license": "MIT",
@@ -17,7 +17,8 @@
   "keywords": [
     "react",
     "tanstack",
-    "keys"
+    "keys",
+    "tanstack-intent"
   ],
   "type": "module",
   "types": "./dist/index.d.ts",
@@ -30,10 +31,11 @@
     "node": ">=20"
   },
   "files": [
-    "dist"
+    "dist",
+    "skills"
   ],
   "dependencies": {
-    "@tanstack/hotkeys": "0.16.1",
+    "@tanstack/hotkeys": "0.18.0",
     "@tanstack/react-store": "^0.11.2"
   },
   "devDependencies": {

package/skills/react-hotkeys/SKILL.md

@@ -0,0 +1,114 @@
+---
+name: react-hotkeys
+description: >-
+  Use when adding or fixing keyboard shortcuts in a React app with
+  @tanstack/react-hotkeys: useHotkey and useHotkeys, refs as targets,
+  HotkeysProvider defaults and dialog scopes, app hotkey hooks, recorders,
+  held-key and hint hooks, or replacing useEffect keydown listeners and other
+  React shortcut libraries.
+metadata:
+  purpose: >-
+    React bindings for TanStack Hotkeys: hooks, providers, refs, and the
+    React-specific mistakes to avoid.
+  type: framework
+  framework: react
+  library: '@tanstack/react-hotkeys'
+  library_version: '0.15.0'
+sources:
+  - src/useHotkey.ts
+  - src/useHotkeys.ts
+  - src/HotkeysProvider.tsx
+  - src/useAppHotkeys.ts
+  - src/utils.ts
+  - TanStack/hotkeys:docs/framework/react/quick-start.md
+  - TanStack/hotkeys:docs/framework/react/guides/hotkeys-provider-and-scopes.md
+  - 'tests/skills/editor-shortcuts/**'
+  - 'tests/skills/shortcut-settings/**'
+requires:
+  - '@tanstack/hotkeys#hotkeys-core'
+---
+
+# TanStack Hotkeys in React
+
+Before starting, load the `@tanstack/hotkeys#hotkeys-core` skill (`npx @tanstack/intent@latest load @tanstack/hotkeys#hotkeys-core`).
+
+```tsx
+import { formatForDisplay, useHotkey } from '@tanstack/react-hotkeys'
+
+export function SaveButton({ onSave }: { onSave: () => void }) {
+  useHotkey('Mod+S', () => onSave(), { meta: { name: 'Save' } })
+
+  return (
+    <button onClick={onSave}>
+      Save <kbd>{formatForDisplay('Mod+S')}</kbd>
+    </button>
+  )
+}
+```
+
+## API
+
+| API                                       | What it's for                                                                                                                                                                                                                        |
+| ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `useHotkey(hotkey, callback, options?)`   | Register one chord, sequence, or app hotkey while the component is mounted.                                                                                                                                                          |
+| `useHotkeys(definitions, commonOptions?)` | Register several hotkeys, or 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 the declared app hotkeys with the user's custom hotkeys applied, to pass to the register API.                                                                                                                                    |
+| `useAppHotkeyList()`                      | List every app hotkey with its status, including ones whose components aren't mounted, for a cheat sheet or settings screen.                                                                                                         |
+| `useCustomHotkeys()`                      | Read, change, and reset the user's custom hotkeys, and check a new one for conflicts.                                                                                                                                                |
+| `useHotkeyRecorder(options)`              | Record a chord or sequence the user presses, for a settings screen.                                                                                                                                                                  |
+| `useHotkeyRegistrations()`                | List every registered hotkey with its options, `meta`, and `status` (whether it's enabled and in an active scope), for a cheat sheet of what's mounted.                                                                              |
+| `useHotkeyScopesState()`                  | Get the active scopes and the exclusive scope that owns the keyboard.                                                                                                                                                                |
+| `useHotkeyHint(hotkey, options?)`         | Get whether held modifiers should reveal a shortcut's hint, such as labels that appear while Mod is held. False unless a registration of the hotkey can fire: enabled, in an active scope, and with focus inside its element target. |
+| `useKeyHold(key)`                         | Get whether one key is held, such as Shift for a range-select mode.                                                                                                                                                                  |
+| `useHeldKeys()`                           | Get every key that's held right now.                                                                                                                                                                                                 |
+| `useHeldKeyCodes()`                       | Map each held key to its physical `event.code`.                                                                                                                                                                                      |
+
+The package also re-exports `@tanstack/hotkeys`, such as `formatForDisplay`, `matchesKeyboardEvent`, and `defineAppHotkeys`.
+
+No provider is required. In React Server Components frameworks, use the hooks and `HotkeysProvider` in client components.
+
+## A dialog that owns the keyboard
+
+```tsx
+import { useId } from 'react'
+import type { ReactNode } from 'react'
+import { HotkeysProvider, useHotkey } from '@tanstack/react-hotkeys'
+
+export function Dialog(props: { onClose: () => void; children: ReactNode }) {
+  return (
+    <HotkeysProvider scope={`dialog-${useId()}`} exclusive>
+      <DialogBody {...props} />
+    </HotkeysProvider>
+  )
+}
+
+function DialogBody({
+  onClose,
+  children,
+}: {
+  onClose: () => void
+  children: ReactNode
+}) {
+  useHotkey('Escape', onClose)
+  return <div role="dialog">{children}</div>
+}
+```
+
+A hook uses the nearest `HotkeysProvider` above its component. Registering `Escape` in `Dialog` itself would put it in the outer scope, which the exclusive scope suspends, so the dialog couldn't close. `useId` gives each open dialog its own scope.
+
+## Pitfalls
+
+- **Pass the ref, not `ref.current`.** `target: listRef.current` is `null` on the first render, and a `null` target means `document`, so the hotkey works page-wide. Pass `target: listRef`; a ref that is still empty waits for its element.
+- **No dependency arrays or `useCallback`.** The hooks read the hotkey, callback, and options on every render, so inline callbacks always see current state.
+- **Call the hooks directly.** A `useShortcut(keys: string)` wrapper has to cast strings to hotkeys, which turns off type checking and drops sequences, options, app hotkeys, and the typed callback context.
+- **`matchesKeyboardEvent` takes the DOM event.** In a widget's `onKeyDown`, pass `event.nativeEvent`.
+- **In tests,** set `<HotkeysProvider defaultOptions={{ hotkey: { platform: 'mac' } }}>`.
+
+When declaring app hotkeys, building a cheat sheet, or letting users rebind shortcuts, load `@tanstack/hotkeys#app-hotkeys` and read [app hotkeys in React](references/app-hotkeys.md).
+
+## API discovery and docs
+
+Signatures: `node_modules/@tanstack/react-hotkeys/dist/*.d.ts`. Guides: `https://tanstack.com/hotkeys/latest/docs/framework/react/guides/<page>.md`, such as `hotkeys`, `hotkeys-provider-and-scopes`, or `app-hotkeys`. Devtools: `hotkeysDevtoolsPlugin()` from `@tanstack/react-hotkeys-devtools` in `@tanstack/react-devtools`.

package/skills/react-hotkeys/references/app-hotkeys.md

@@ -0,0 +1,80 @@
+# App hotkeys in React
+
+The `@tanstack/hotkeys#app-hotkeys` skill owns the rules. This is the React wiring.
+
+```ts
+// app-hotkeys.ts
+import { defineAppHotkeys } from '@tanstack/react-hotkeys'
+
+export const appHotkeys = defineAppHotkeys({
+  'doc.save': { hotkey: 'Mod+S', meta: { name: 'Save' } },
+  'help.shortcuts': { hotkey: 'Mod+/', meta: { name: 'Keyboard shortcuts' } },
+})
+
+declare module '@tanstack/react-hotkeys' {
+  interface Register {
+    appHotkeys: typeof appHotkeys
+  }
+}
+```
+
+```tsx
+import type { ReactNode } from 'react'
+import { HotkeysProvider } from '@tanstack/react-hotkeys'
+import type { CustomHotkeys } from '@tanstack/react-hotkeys'
+import { appHotkeys } from './app-hotkeys'
+
+const saved: CustomHotkeys = JSON.parse(localStorage.getItem('hotkeys') ?? '{}')
+
+export function Root({ children }: { children: ReactNode }) {
+  return (
+    <HotkeysProvider
+      appHotkeys={appHotkeys}
+      customHotkeys={saved}
+      onCustomHotkeysChange={(custom) =>
+        localStorage.setItem('hotkeys', JSON.stringify(custom))
+      }
+    >
+      {children}
+    </HotkeysProvider>
+  )
+}
+```
+
+Register with `useHotkey(appHotkeys['doc.save'], save)`, using the import or `useAppHotkeys()`. Build a cheat sheet from `useAppHotkeyList()`.
+
+A settings row records with `useHotkeyRecorder` and saves through `useCustomHotkeys`:
+
+```tsx
+import {
+  formatForDisplay,
+  useAppHotkeys,
+  useCustomHotkeys,
+  useHotkeyRecorder,
+} from '@tanstack/react-hotkeys'
+import type { AppHotkeyId } from '@tanstack/react-hotkeys'
+
+export function ShortcutRow({ id }: { id: AppHotkeyId }) {
+  const appHotkey = useAppHotkeys()[id]
+  const { findConflicts, setCustomHotkey, resetCustomHotkey } =
+    useCustomHotkeys()
+  const recorder = useHotkeyRecorder({
+    maxSteps: Infinity,
+    validate: (hotkey) => {
+      const [conflict] = findConflicts(id, hotkey)
+      return conflict ? `Used by ${conflict.meta?.name ?? conflict.id}` : true
+    },
+    onRecord: (hotkey) => setCustomHotkey(id, hotkey),
+    onClear: () => setCustomHotkey(id, null),
+  })
+
+  return (
+    <div>
+      {appHotkey.meta?.name}:{' '}
+      {appHotkey.hotkey ? formatForDisplay(appHotkey.hotkey) : 'Unassigned'}
+      <button onClick={recorder.startRecording}>Change</button>
+      <button onClick={() => resetCustomHotkey(id)}>Reset</button>
+    </div>
+  )
+}
+```