@tanstack/solid-hotkeys 0.18.0 → 0.19.0

package/dist/HotkeysProvider.d.ts

@@ -27,8 +27,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

@@ -42,6 +42,10 @@ const HotkeysProvider = (props) => {
 	createEffect(() => {
 		if (props.appHotkeys) store?.setAppHotkeys(props.appHotkeys);
 	});
+	createEffect(() => {
+		const customHotkeys = props.customHotkeys;
+		store?.setOptions({ customHotkeys });
+	});
 	onMount(() => {
 		if (store) onCleanup(publishAppHotkeysStore(store));
 	});

package/dist/createHotkey.d.ts

@@ -29,6 +29,7 @@ type MaybeAccessor<T> = T | (() => T);
  * sequence registers as its chord. An app hotkey uses its effective hotkey
  * from `HotkeysProvider` (including the user's custom hotkey) and its
  * declared meta and options, and registers nothing while unbound.
+ * `undefined`, `null`, or `''` registers nothing, for an optional shortcut.
  *
  * @example
  * ```tsx
@@ -37,6 +38,6 @@ type MaybeAccessor<T> = T | (() => T);
  * createHotkey('Escape', () => close(), () => ({ enabled: isOpen() }))
  * ```
  */
-export declare function createHotkey<T extends AppHotkey>(hotkey: MaybeAccessor<T>, callback: HotkeyCallback, options?: MaybeAccessor<CreateAppHotkeyOptions<T>>): void;
-export declare function createHotkey<const T extends RegisterableHotkey>(hotkey: MaybeAccessor<T>, callback: HotkeyCallback<HotkeyCallbackContextFor<T>>, options?: MaybeAccessor<CreateHotkeyOptionsFor<T>>): void;
+export declare function createHotkey<T extends AppHotkey>(hotkey: MaybeAccessor<T | null | undefined>, callback: HotkeyCallback, options?: MaybeAccessor<CreateAppHotkeyOptions<T>>): void;
+export declare function createHotkey<const T extends RegisterableHotkey>(hotkey: MaybeAccessor<T | null | undefined>, callback: HotkeyCallback<HotkeyCallbackContextFor<T>>, options?: MaybeAccessor<CreateHotkeyOptionsFor<T>>): void;
 //#endregion

package/dist/createHotkeyHint.d.ts

@@ -5,7 +5,8 @@ import { AppHotkey, HeldModifierOptions, RegisterableHotkey } from "@tanstack/ho
  * 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.
+ * effective hotkey (false while unbound). No hotkey (`undefined`, `null`, or
+ * `''`) returns false. 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;
+export declare function createHotkeyHint(hotkey: RegisterableHotkey | AppHotkey | null | undefined | (() => RegisterableHotkey | AppHotkey | null | undefined), options?: HeldModifierOptions | (() => HeldModifierOptions)): () => boolean;
 //#endregion

package/dist/createHotkeyHint.js

@@ -9,7 +9,8 @@ import { createMemo } from "solid-js";
 * 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.
+* effective hotkey (false while unbound). No hotkey (`undefined`, `null`, or
+* `''`) returns false. 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();

package/dist/createHotkeyRecorder.js

@@ -2,14 +2,12 @@ import { useSelector } from "./_useSelector.js";
 import { useDefaultHotkeysOptionsSource } from "./defaultOptions.js";
 import { HotkeyRecorder } from "@tanstack/hotkeys";
 import { createEffect, onCleanup } from "solid-js";
+import { withDefaults } from "@tanstack/hotkeys/adapter";
 
 //#region src/createHotkeyRecorder.ts
 function createHotkeyRecorder(options) {
 	const defaultOptions = useDefaultHotkeysOptionsSource();
-	const resolve = () => ({
-		...defaultOptions().hotkeyRecorder,
-		...typeof options === "function" ? options() : options
-	});
+	const resolve = () => withDefaults(defaultOptions().hotkeyRecorder, typeof options === "function" ? options() : options);
 	const recorder = new HotkeyRecorder(resolve());
 	const isRecording = useSelector(recorder.store, (state) => state.isRecording);
 	const steps = useSelector(recorder.store, (state) => state.steps);

package/dist/createHotkeys.d.ts

@@ -12,7 +12,8 @@ export type CreateHotkeyDefinition = AdapterHotkeyDefinition<CreateHotkeyTarget>
  *
  * Options merge in this order: provider defaults, app hotkey declaration,
  * commonOptions, per-hotkey options. Each option applies only to the kinds
- * that support it. Unbound app hotkeys and empty sequences register nothing.
+ * that support it. Unbound app hotkeys, empty sequences, and `undefined`,
+ * `null`, or `''` hotkeys register nothing.
  * A `null` target skips registration until it is set.
  *
  * @example

package/dist/createHotkeys.js

@@ -9,7 +9,8 @@ import { createHotkeyBindings, prepareHotkeyDefinitions } from "@tanstack/hotkey
 *
 * Options merge in this order: provider defaults, app hotkey declaration,
 * commonOptions, per-hotkey options. Each option applies only to the kinds
-* that support it. Unbound app hotkeys and empty sequences register nothing.
+* that support it. Unbound app hotkeys, empty sequences, and `undefined`,
+* `null`, or `''` hotkeys register nothing.
 * A `null` target skips registration until it is set.
 *
 * @example

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/solid-hotkeys",
-  "version": "0.18.0",
+  "version": "0.19.0",
   "description": "SolidJS adapter for TanStack Hotkeys",
   "author": "Tanner Linsley",
   "license": "MIT",
@@ -38,7 +38,7 @@
     "skills"
   ],
   "dependencies": {
-    "@tanstack/hotkeys": "0.20.0"
+    "@tanstack/hotkeys": "0.21.0"
   },
   "devDependencies": {
     "@solidjs/testing-library": "^0.8.10",