@tanstack/ember-hotkeys 0.7.0 → 0.8.0

package/dist/bindings.js

@@ -6,6 +6,7 @@ import { createHotkeyBindings, prepareHotkeyDefinitions, subscribePublishedAppHo
 //#region src/bindings.ts
 /** Copies a hotkey so tracked getters are read while Ember tracks the caller. */
 function copyHotkey(hotkey) {
+	if (hotkey == null) return hotkey;
 	if (typeof hotkey === "string" || isAppHotkey(hotkey)) return hotkey;
 	if (isHotkeySequence(hotkey)) return [...hotkey];
 	return { ...hotkey };

package/dist/createHotkeysScope.js

@@ -4,6 +4,7 @@ import { read } from "./utils.js";
 import { useHotkeyRecorder } from "./useHotkeyRecorder.js";
 import { OnHotkey } from "./onHotkey.js";
 import { OnHotkeys } from "./onHotkeys.js";
+import { definedOptions, withDefaults } from "@tanstack/hotkeys/adapter";
 
 //#region src/createHotkeysScope.ts
 /**
@@ -14,40 +15,25 @@ function createHotkeysScope(defaultOptions = {}) {
 	return {
 		onHotkey: class extends OnHotkey {
 			modify(...[element, args, options]) {
-				super.modify(element, args, {
-					...read(defaultOptions).hotkey,
-					...options
-				});
+				super.modify(element, args, { ...definedOptions(read(defaultOptions).hotkey, options) });
 			}
 		},
 		onHotkeys: class extends OnHotkeys {
 			modify(...[element, args, options]) {
-				super.modify(element, args, {
-					...read(defaultOptions).hotkey,
-					...options
-				});
+				super.modify(element, args, { ...definedOptions(read(defaultOptions).hotkey, options) });
 			}
 		},
 		useHotkey: class extends UseHotkey {
 			compute(...[args, options]) {
-				super.compute(args, {
-					...read(defaultOptions).hotkey,
-					...options
-				});
+				super.compute(args, { ...definedOptions(read(defaultOptions).hotkey, options) });
 			}
 		},
 		useHotkeys: class extends UseHotkeys {
 			compute(...[args, options]) {
-				super.compute(args, {
-					...read(defaultOptions).hotkey,
-					...options
-				});
+				super.compute(args, { ...definedOptions(read(defaultOptions).hotkey, options) });
 			}
 		},
-		useHotkeyRecorder: ((owner, options) => useHotkeyRecorder(owner, () => ({
-			...read(defaultOptions).hotkeyRecorder,
-			...read(options)
-		})))
+		useHotkeyRecorder: ((owner, options) => useHotkeyRecorder(owner, () => withDefaults(read(defaultOptions).hotkeyRecorder, read(options))))
 	};
 }
 

package/dist/onHotkey.d.ts

@@ -2,15 +2,19 @@ import { ElementHotkeyOptions } from "./onHotkeys.js";
 import { AppHotkey, HotkeyCallback, RegisterableHotkey } from "@tanstack/hotkeys";
 import Modifier from "ember-modifier";
 //#region src/onHotkey.d.ts
-/** Attaches a hotkey (chord, sequence, or app hotkey) to the element that owns the modifier. */
+/**
+ * Attaches a hotkey (chord, sequence, or app hotkey) to the element that owns
+ * the modifier. `undefined`, `null`, or `''` registers nothing, for an
+ * optional shortcut.
+ */
 export declare class OnHotkey extends Modifier<{
   Element: HTMLElement;
   Args: {
-    Positional: [RegisterableHotkey | AppHotkey, HotkeyCallback];
+    Positional: [RegisterableHotkey | AppHotkey | null | undefined, HotkeyCallback];
     Named: ElementHotkeyOptions;
   };
 }> {
   private bindings;
-  modify(element: HTMLElement, [hotkey, callback]: [RegisterableHotkey | AppHotkey, HotkeyCallback], options: ElementHotkeyOptions): void;
+  modify(element: HTMLElement, [hotkey, callback]: [RegisterableHotkey | AppHotkey | null | undefined, HotkeyCallback], options: ElementHotkeyOptions): void;
 }
 //#endregion

package/dist/onHotkey.js

@@ -2,7 +2,11 @@ import { createOwnedBindings } from "./bindings.js";
 import Modifier from "ember-modifier";
 
 //#region src/onHotkey.ts
-/** Attaches a hotkey (chord, sequence, or app hotkey) to the element that owns the modifier. */
+/**
+* Attaches a hotkey (chord, sequence, or app hotkey) to the element that owns
+* the modifier. `undefined`, `null`, or `''` registers nothing, for an
+* optional shortcut.
+*/
 var OnHotkey = class extends Modifier {
 	bindings = createOwnedBindings(this);
 	modify(element, [hotkey, callback], options) {

package/dist/useHotkey.d.ts

@@ -7,15 +7,16 @@ import Helper from "@ember/component/helper";
  * `"Mod+S"`, a sequence such as `(array "G" "G")`, or an app hotkey.
  *
  * Use `{{useHotkey "Mod+S" this.save enabled=this.enabled}}` in a template.
+ * `undefined`, `null`, or `''` registers nothing, for an optional shortcut.
  */
 export declare class UseHotkey extends Helper<{
   Args: {
-    Positional: [RegisterableHotkey | AppHotkey, HotkeyCallback];
+    Positional: [RegisterableHotkey | AppHotkey | null | undefined, HotkeyCallback];
     Named: EmberHotkeyCommonOptions;
   };
   Return: void;
 }> {
   private bindings;
-  compute([hotkey, callback]: [RegisterableHotkey | AppHotkey, HotkeyCallback], options: EmberHotkeyCommonOptions): void;
+  compute([hotkey, callback]: [RegisterableHotkey | AppHotkey | null | undefined, HotkeyCallback], options: EmberHotkeyCommonOptions): void;
 }
 //#endregion

package/dist/useHotkey.js

@@ -7,6 +7,7 @@ import Helper from "@ember/component/helper";
 * `"Mod+S"`, a sequence such as `(array "G" "G")`, or an app hotkey.
 *
 * Use `{{useHotkey "Mod+S" this.save enabled=this.enabled}}` in a template.
+* `undefined`, `null`, or `''` registers nothing, for an optional shortcut.
 */
 var UseHotkey = class extends Helper {
 	bindings = createOwnedBindings(this);

package/dist/useHotkeyHint.d.ts

@@ -7,7 +7,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). A hotkey on an element counts only while focus is inside it.
+ * effective hotkey (false 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(owner: object, hotkey: MaybeGetter<RegisterableHotkey | AppHotkey>, options?: MaybeGetter<HeldModifierOptions>): EmberHotkeyState<boolean>;
+export declare function useHotkeyHint(owner: object, hotkey: MaybeGetter<RegisterableHotkey | AppHotkey | null | undefined>, options?: MaybeGetter<HeldModifierOptions>): EmberHotkeyState<boolean>;
 //#endregion

package/dist/useHotkeyHint.js

@@ -7,7 +7,8 @@ import { getHotkeyManager, getKeyStateTracker, isAppHotkey, matchesHeldModifiers
 * 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). A hotkey on an element counts only while focus is inside it.
+* effective hotkey (false while unbound). No hotkey (`undefined`, `null`, or
+* `''`) returns false. A hotkey on an element counts only while focus is inside it.
 */
 function useHotkeyHint(owner, hotkey, options = {}) {
 	const appHotkeys = trackPublishedAppHotkeys(owner);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/ember-hotkeys",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "description": "Ember adapter for TanStack Hotkeys",
   "author": "Tanner Linsley",
   "license": "MIT",
@@ -40,7 +40,7 @@
   ],
   "dependencies": {
     "@embroider/addon-shim": "^1.10.3",
-    "@tanstack/hotkeys": "0.20.0",
+    "@tanstack/hotkeys": "0.21.0",
     "ember-modifier": "^4.2.2"
   },
   "devDependencies": {