@tanstack/octane-hotkeys 0.8.0 → 0.9.0

package/dist/HotkeysProvider.d.ts

@@ -29,8 +29,10 @@ export interface HotkeysProviderProps extends HotkeysProviderScopeProps {
    */
   appHotkeys?: AppHotkeys;
   /**
-   * Starting custom hotkeys, such as saved data. Read once; the provider owns
-   * the state afterwards. Invalid entries are ignored with a warning.
+   * The user's saved custom hotkeys. When the value changes, such as after
+   * saved data loads or the user signs in, it replaces the current custom
+   * hotkeys. `undefined` leaves them unchanged; `null` clears them. Invalid
+   * entries are ignored with a warning.
    */
   customHotkeys?: CustomHotkeys | null;
   /** Called with the custom hotkeys after every change, ready to save. */

package/dist/HotkeysProvider.js

@@ -33,6 +33,9 @@ function HotkeysProvider({ children, defaultOptions, appHotkeys, customHotkeys,
 	useLayoutEffect(() => {
 		if (appHotkeys) store?.setAppHotkeys(appHotkeys);
 	}, [store, appHotkeys], subSlot(void 0, "provider-declarations"));
+	useLayoutEffect(() => {
+		store?.setOptions({ customHotkeys });
+	}, [store, customHotkeys], subSlot(void 0, "provider-custom-hotkeys"));
 	useLayoutEffect(() => store ? publishAppHotkeysStore(store) : void 0, [store], subSlot(void 0, "provider-publish"));
 	const active = (parent?.enabled ?? true) && enabled;
 	const scopeKey = getHotkeysProviderScopeKey({

package/dist/useHotkey.d.ts

@@ -18,8 +18,9 @@ export type UseAppHotkeyOptions<T extends AppHotkey = AppHotkey> = AdapterAppHot
 /**
  * Registers one hotkey: a chord such as `'Mod+S'`, a sequence such as
  * `['G', 'G']`, or an app hotkey from `defineAppHotkeys`. The callback and
- * options are refreshed after every commit.
+ * options are refreshed after every commit. `undefined`, `null`, or `''`
+ * registers nothing, for an optional shortcut.
  */
-export declare function useHotkey<T extends AppHotkey>(hotkey: T, callback: HotkeyCallback, options?: UseAppHotkeyOptions<T>): void;
-export declare function useHotkey<const T extends RegisterableHotkey>(hotkey: T, callback: HotkeyCallback<HotkeyCallbackContextFor<T>>, options?: UseHotkeyOptionsFor<T>): void;
+export declare function useHotkey<T extends AppHotkey>(hotkey: T | null | undefined, callback: HotkeyCallback, options?: UseAppHotkeyOptions<T>): void;
+export declare function useHotkey<const T extends RegisterableHotkey>(hotkey: T | null | undefined, callback: HotkeyCallback<HotkeyCallbackContextFor<T>>, options?: UseHotkeyOptionsFor<T>): void;
 //#endregion

package/dist/useHotkeyHint.d.ts

@@ -5,7 +5,8 @@ import { AppHotkey, HeldModifierOptions, RegisterableHotkey } from "@tanstack/ho
  * 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.
+ * while unbound). No hotkey (`undefined`, `null`, or `''`) returns false. A
+ * hotkey on an element counts only while focus is inside it.
  */
-export declare function useHotkeyHint(hotkey: RegisterableHotkey | AppHotkey, options?: HeldModifierOptions): boolean;
+export declare function useHotkeyHint(hotkey: RegisterableHotkey | AppHotkey | null | undefined, options?: HeldModifierOptions): boolean;
 //#endregion

package/dist/useHotkeyRecorder.js

@@ -2,13 +2,12 @@ import { select, subSlot } from "./internal.js";
 import { useDefaultHotkeysOptions } from "./HotkeysProvider.js";
 import { HotkeyRecorder } from "@tanstack/hotkeys";
 import { useLayoutEffect, useRef } from "octane";
+import { withDefaults } from "@tanstack/hotkeys/adapter";
 
 //#region src/useHotkeyRecorder.ts
 function useHotkeyRecorder(options, slot) {
-	const merged = {
-		...useDefaultHotkeysOptions().hotkeyRecorder,
-		...options
-	};
+	const defaults = useDefaultHotkeysOptions();
+	const merged = withDefaults(defaults.hotkeyRecorder, options);
 	const ref = useRef(null, subSlot(slot, "recorder"));
 	ref.current ??= new HotkeyRecorder(merged);
 	const recorder = ref.current;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/octane-hotkeys",
-  "version": "0.8.0",
+  "version": "0.9.0",
   "description": "Octane adapter for TanStack Hotkeys",
   "author": "Tanner Linsley",
   "license": "MIT",
@@ -35,7 +35,7 @@
     "skills"
   ],
   "dependencies": {
-    "@tanstack/hotkeys": "0.20.0"
+    "@tanstack/hotkeys": "0.21.0"
   },
   "devDependencies": {
     "@tsrx/oxc": "0.20.0",