@tanstack/angular-hotkeys 0.18.0 → 0.19.1

package/dist/hotkeys-provider.d.ts

@@ -33,10 +33,12 @@ export interface ProvideHotkeysOptions {
    */
   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;
+  customHotkeys?: MaybeGetter<CustomHotkeys | null | undefined>;
   /** Called with the custom hotkeys after every change, ready to save. */
   onCustomHotkeysChange?: (customHotkeys: CustomHotkeys) => void;
 }

package/dist/hotkeys-provider.js

@@ -1,5 +1,5 @@
 import { publishAppHotkeysStore } from "@tanstack/hotkeys";
-import { DestroyRef, InjectionToken, Injector, computed, effect, inject, runInInjectionContext, signal } from "@angular/core";
+import { DestroyRef, InjectionToken, Injector, computed, effect, inject, runInInjectionContext, signal, untracked } from "@angular/core";
 import { activateHotkeysProviderScope, createAppHotkeysStore, getHotkeysProviderScopeKey, mergeHotkeysProviderDefaults } from "@tanstack/hotkeys/adapter";
 
 //#region src/hotkeys-provider.ts
@@ -27,10 +27,15 @@ function createHotkeysContext(options) {
 	let store = null;
 	let appHotkeysState = parent.appHotkeysState;
 	if (appHotkeys) {
-		store = createAppHotkeysStore(appHotkeys, {
-			customHotkeys,
+		const owned = createAppHotkeysStore(appHotkeys, {
+			customHotkeys: read(customHotkeys),
 			onCustomHotkeysChange
 		});
+		store = owned;
+		if (typeof customHotkeys === "function") effect(() => {
+			const next = read(customHotkeys);
+			untracked(() => owned.setOptions({ customHotkeys: next }));
+		});
 		const state = signal(store.store.state);
 		const subscription = store.store.subscribe(() => state.set(store.store.state));
 		destroyRef.onDestroy(() => subscription.unsubscribe());

package/dist/injectHotkey.d.ts

@@ -28,7 +28,9 @@ type MaybeGetter<T> = T | (() => T);
  * Chords accept `requireReset`; sequences accept `timeout`. A one-step
  * sequence registers as its chord. An app hotkey uses its effective hotkey
  * from `provideHotkeys` (including the user's custom hotkey) and its declared
- * meta and options, and registers nothing while unbound.
+ * meta and options, and registers nothing while unbound. A hotkey of
+ * `undefined`, `null`, or `''` registers nothing, for an optional shortcut
+ * such as `() => this.shortcut()`; when it changes to a hotkey, it registers.
  *
  * @example
  * ```ts
@@ -42,6 +44,6 @@ type MaybeGetter<T> = T | (() => T);
  * }
  * ```
  */
-export declare function injectHotkey<T extends AppHotkey>(hotkey: MaybeGetter<T>, callback: HotkeyCallback, options?: MaybeGetter<InjectAppHotkeyOptions<T>>): void;
-export declare function injectHotkey<const T extends RegisterableHotkey>(hotkey: MaybeGetter<T>, callback: HotkeyCallback<HotkeyCallbackContextFor<T>>, options?: MaybeGetter<InjectHotkeyOptionsFor<T>>): void;
+export declare function injectHotkey<T extends AppHotkey>(hotkey: MaybeGetter<T | null | undefined>, callback: HotkeyCallback, options?: MaybeGetter<InjectAppHotkeyOptions<T>>): void;
+export declare function injectHotkey<const T extends RegisterableHotkey>(hotkey: MaybeGetter<T | null | undefined>, callback: HotkeyCallback<HotkeyCallbackContextFor<T>>, options?: MaybeGetter<InjectHotkeyOptionsFor<T>>): void;
 //#endregion

package/dist/injectHotkeyHint.d.ts

@@ -7,7 +7,8 @@ import { Signal } from "@angular/core";
  * 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.
+ * 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 injectHotkeyHint(hotkey: RegisterableHotkey | AppHotkey | (() => RegisterableHotkey | AppHotkey), options?: HeldModifierOptions | (() => HeldModifierOptions)): Signal<boolean>;
+export declare function injectHotkeyHint(hotkey: RegisterableHotkey | AppHotkey | null | undefined | (() => RegisterableHotkey | AppHotkey | null | undefined), options?: HeldModifierOptions | (() => HeldModifierOptions)): Signal<boolean>;
 //#endregion

package/dist/injectHotkeyHint.js

@@ -10,7 +10,8 @@ import { computed } from "@angular/core";
 * 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.
+* 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 injectHotkeyHint(hotkey, options = {}) {
 	const context = injectHotkeysContext();

package/dist/injectHotkeyRecorder.js

@@ -1,6 +1,7 @@
 import { injectDefaultHotkeysOptions } from "./hotkeys-provider.js";
 import { HotkeyRecorder } from "@tanstack/hotkeys";
 import { DestroyRef, computed, effect, inject, linkedSignal, untracked } from "@angular/core";
+import { withDefaults } from "@tanstack/hotkeys/adapter";
 
 //#region src/injectHotkeyRecorder.ts
 function injectHotkeyRecorder(options) {
@@ -8,10 +9,7 @@ function injectHotkeyRecorder(options) {
 	const destroyRef = inject(DestroyRef);
 	const recorderSignal = computed(() => untracked(() => {
 		const resolvedOptions = typeof options === "function" ? options() : options;
-		return new HotkeyRecorder({
-			...defaultOptions.hotkeyRecorder,
-			...resolvedOptions
-		});
+		return new HotkeyRecorder(withDefaults(defaultOptions.hotkeyRecorder, resolvedOptions));
 	}));
 	const recorderStore = computed(() => untracked(() => recorderSignal().store));
 	const isRecording = injectLazyStore(recorderStore, (state) => state.isRecording);
@@ -19,10 +17,7 @@ function injectHotkeyRecorder(options) {
 	const recordedHotkey = injectLazyStore(recorderStore, (state) => state.recordedHotkey);
 	effect(() => {
 		const resolved = typeof options === "function" ? options() : options;
-		recorderSignal().setOptions({
-			...defaultOptions.hotkeyRecorder,
-			...resolved
-		});
+		recorderSignal().setOptions(withDefaults(defaultOptions.hotkeyRecorder, resolved));
 	});
 	destroyRef.onDestroy(() => {
 		recorderSignal().destroy();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/angular-hotkeys",
-  "version": "0.18.0",
+  "version": "0.19.1",
   "description": "Angular adapter for TanStack Hotkeys",
   "author": "Tanner Linsley",
   "license": "MIT",
@@ -37,7 +37,7 @@
     "skills"
   ],
   "dependencies": {
-    "@tanstack/hotkeys": "0.20.0"
+    "@tanstack/hotkeys": "0.22.0"
   },
   "peerDependencies": {
     "@angular/common": ">=19.0.0",