@tanstack/svelte-hotkeys 0.18.0 → 0.19.1

package/dist/HotkeysCtx.d.ts

@@ -21,8 +21,10 @@ export interface HotkeysContextOptions extends HotkeysProviderScopeProps {
      */
     appHotkeys?: AppHotkeys;
     /**
-     * Starting custom hotkeys, such as saved data. Read once; the context 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.svelte

@@ -28,6 +28,12 @@
   $effect(() => {
     if (appHotkeys) context.appHotkeysStore?.setAppHotkeys(appHotkeys)
   })
+
+  // Apply saved custom hotkeys whose value changes, such as data that loads
+  // after the first render. Only a provider with appHotkeys owns a store.
+  $effect(() => {
+    if (appHotkeys) context.appHotkeysStore?.setOptions({ customHotkeys })
+  })
 </script>
 
 {@render children()}

package/dist/createHotkey.svelte.d.ts

@@ -26,6 +26,7 @@ export type CreateAppHotkeyOptions<T extends AppHotkey = AppHotkey> = AdapterApp
  * 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
  * ```svelte
@@ -36,11 +37,12 @@ export type CreateAppHotkeyOptions<T extends AppHotkey = AppHotkey> = AdapterApp
  * </script>
  * ```
  */
-export declare function createHotkey<T extends AppHotkey>(hotkey: MaybeGetter<T>, callback: HotkeyCallback, options?: MaybeGetter<CreateAppHotkeyOptions<T>>): void;
-export declare function createHotkey<const T extends RegisterableHotkey>(hotkey: MaybeGetter<T>, callback: HotkeyCallback<HotkeyCallbackContextFor<T>>, options?: MaybeGetter<CreateHotkeyOptionsFor<T>>): void;
+export declare function createHotkey<T extends AppHotkey>(hotkey: MaybeGetter<T | null | undefined>, callback: HotkeyCallback, options?: MaybeGetter<CreateAppHotkeyOptions<T>>): void;
+export declare function createHotkey<const T extends RegisterableHotkey>(hotkey: MaybeGetter<T | null | undefined>, callback: HotkeyCallback<HotkeyCallbackContextFor<T>>, options?: MaybeGetter<CreateHotkeyOptionsFor<T>>): void;
 /**
  * Create an attachment for an element-scoped hotkey: a chord, a sequence, or
- * an app hotkey that listens on the attached element.
+ * an app hotkey that listens on the attached element. `undefined`, `null`,
+ * or `''` registers nothing, for an optional shortcut.
  *
  * @example
  * ```svelte
@@ -51,5 +53,5 @@ export declare function createHotkey<const T extends RegisterableHotkey>(hotkey:
  * <div tabindex="0" {@attach saveKey}>Editor content</div>
  * ```
  */
-export declare function createHotkeyAttachment<T extends AppHotkey>(hotkey: MaybeGetter<T>, callback: HotkeyCallback, options?: MaybeGetter<CreateAppHotkeyOptions<T>>): Attachment<HTMLElement>;
-export declare function createHotkeyAttachment<const T extends RegisterableHotkey>(hotkey: MaybeGetter<T>, callback: HotkeyCallback<HotkeyCallbackContextFor<T>>, options?: MaybeGetter<CreateHotkeyOptionsFor<T>>): Attachment<HTMLElement>;
+export declare function createHotkeyAttachment<T extends AppHotkey>(hotkey: MaybeGetter<T | null | undefined>, callback: HotkeyCallback, options?: MaybeGetter<CreateAppHotkeyOptions<T>>): Attachment<HTMLElement>;
+export declare function createHotkeyAttachment<const T extends RegisterableHotkey>(hotkey: MaybeGetter<T | null | undefined>, callback: HotkeyCallback<HotkeyCallbackContextFor<T>>, options?: MaybeGetter<CreateHotkeyOptionsFor<T>>): Attachment<HTMLElement>;

package/dist/createHotkeyRecorder.svelte.js

@@ -1,4 +1,5 @@
 import { HotkeyRecorder } from '@tanstack/hotkeys';
+import { withDefaults } from '@tanstack/hotkeys/adapter';
 import { getDefaultHotkeysOptions } from './HotkeysCtx.js';
 import { createStoreSubscriber, resolveMaybeGetter } from './internal.svelte.js';
 class SvelteHotkeyRecorderState {
@@ -41,10 +42,7 @@ class SvelteHotkeyRecorderState {
     }
 }
 export function createHotkeyRecorder(options) {
-    const resolve = () => ({
-        ...getDefaultHotkeysOptions().hotkeyRecorder,
-        ...resolveMaybeGetter(options),
-    });
+    const resolve = () => withDefaults(getDefaultHotkeysOptions().hotkeyRecorder, resolveMaybeGetter(options));
     // Overloads already checked the options; either shape is valid here.
     const recorder = new SvelteHotkeyRecorderState(resolve());
     $effect(() => {

package/dist/createHotkeys.svelte.d.ts

@@ -25,8 +25,11 @@ export type CreateHotkeyDefinition = {
     callback: HotkeyCallback;
     options?: MaybeGetter<CreateAppHotkeyOptions>;
 } | {
-    /** A hotkey whose kind is not known statically. Accepts only shared options. */
-    hotkey: MaybeGetter<RegisterableHotkey>;
+    /**
+     * A hotkey whose kind is not known statically. Accepts only shared
+     * options. `undefined`, `null`, or `''` registers nothing.
+     */
+    hotkey: MaybeGetter<RegisterableHotkey | null | undefined>;
     callback: HotkeyCallback;
     options?: MaybeGetter<CreateHotkeyOptions>;
 };
@@ -37,7 +40,8 @@ export type CreateHotkeyDefinition = {
  *
  * 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.
  *
  * @example
  * ```svelte

package/dist/createHotkeys.svelte.js

@@ -40,7 +40,8 @@ function bindHotkeys(hotkeys, commonOptions, element) {
  *
  * 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.
  *
  * @example
  * ```svelte

package/dist/getHotkeyHint.svelte.d.ts

@@ -9,6 +9,7 @@ export interface SvelteHotkeyHint {
  * fire: some registration of it is enabled and in an active scope. Pass
  * getters to track changing hotkeys and options. 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.
+ * uses its 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 getHotkeyHint(hotkey: MaybeGetter<RegisterableHotkey | AppHotkey>, options?: MaybeGetter<HeldModifierOptions>): SvelteHotkeyHint;
+export declare function getHotkeyHint(hotkey: MaybeGetter<RegisterableHotkey | AppHotkey | null | undefined>, options?: MaybeGetter<HeldModifierOptions>): SvelteHotkeyHint;

package/dist/getHotkeyHint.svelte.js

@@ -8,7 +8,8 @@ import { resolveMaybeGetter } from './internal.svelte.js';
  * fire: some registration of it is enabled and in an active scope. Pass
  * getters to track changing hotkeys and options. 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.
+ * uses its 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 function getHotkeyHint(hotkey, options = {}) {
     const tracker = getKeyStateTracker();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/svelte-hotkeys",
-  "version": "0.18.0",
+  "version": "0.19.1",
   "description": "Svelte adapter for TanStack Hotkeys",
   "author": "Kunal Rao",
   "license": "MIT",
@@ -41,7 +41,7 @@
     "skills"
   ],
   "dependencies": {
-    "@tanstack/hotkeys": "0.20.0"
+    "@tanstack/hotkeys": "0.22.0"
   },
   "devDependencies": {
     "@sveltejs/package": "^3.0.0",