@tanstack/alpine-hotkeys 0.7.0 → 0.9.0

package/dist/createHotkeyRecorder.js

@@ -1,13 +1,11 @@
 import { read } from "./scope.js";
 import { HotkeyRecorder } from "@tanstack/hotkeys";
+import { withDefaults } from "@tanstack/hotkeys/adapter";
 
 //#region src/createHotkeyRecorder.ts
 function createHotkeyRecorder(scope, options) {
 	scope.assertActive();
-	const instance = new HotkeyRecorder(() => ({
-		...scope.defaultOptions().hotkeyRecorder,
-		...read(options)
-	}));
+	const instance = new HotkeyRecorder(() => withDefaults(scope.defaultOptions().hotkeyRecorder, read(options)));
 	const state = scope.select(instance.store, (value) => value);
 	scope.addCleanup(() => instance.destroy());
 	return {

package/dist/types.d.ts

@@ -57,8 +57,8 @@ export interface AlpineCustomHotkeys {
 export type MaybeGetter<T> = T | (() => T);
 /** Registers a hotkey: a chord, a sequence, or an app hotkey. */
 export interface AlpineCreateHotkey {
-  <T extends AppHotkey>(hotkey: MaybeGetter<T>, callback: HotkeyCallback, options?: MaybeGetter<AlpineAppHotkeyOptions<T>>): void;
-  <const T extends RegisterableHotkey>(hotkey: MaybeGetter<T>, callback: HotkeyCallback<HotkeyCallbackContextFor<T>>, options?: MaybeGetter<AlpineHotkeyOptionsFor<T>>): void;
+  <T extends AppHotkey>(hotkey: MaybeGetter<T | null | undefined>, callback: HotkeyCallback, options?: MaybeGetter<AlpineAppHotkeyOptions<T>>): void;
+  <const T extends RegisterableHotkey>(hotkey: MaybeGetter<T | null | undefined>, callback: HotkeyCallback<HotkeyCallbackContextFor<T>>, options?: MaybeGetter<AlpineHotkeyOptionsFor<T>>): void;
 }
 /** Creates a recorder; `maxSteps` (default 1) selects chords or sequences. */
 export interface AlpineCreateHotkeyRecorder {
@@ -73,6 +73,7 @@ export interface AlpineHotkeys {
   /**
    * Register one hotkey: a chord such as `'Mod+S'`, a sequence such as
    * `['G', 'G']`, or an app hotkey. Getters track changing hotkeys and options.
+   * `undefined`, `null`, or `''` registers nothing, for an optional shortcut.
    */
   createHotkey: AlpineCreateHotkey;
   /** Reconcile a list of hotkeys. Definition options override common options. */
@@ -83,8 +84,11 @@ export interface AlpineHotkeys {
   createHeldKeyCodes: () => AlpineHotkeyState<Record<string, string>>;
   /** Read whether a key is held through `.value`. */
   createKeyHold: (key: MaybeGetter<IndividualKey>) => AlpineHotkeyState<boolean>;
-  /** Read whether held modifiers reveal a hotkey through `.value`. */
-  createHotkeyHint: (hotkey: MaybeGetter<RegisterableHotkey | AppHotkey>, options?: MaybeGetter<HeldModifierOptions>) => AlpineHotkeyState<boolean>;
+  /**
+   * Read whether held modifiers reveal a hotkey through `.value`. No hotkey
+   * (`undefined`, `null`, or `''`) is never visible.
+   */
+  createHotkeyHint: (hotkey: MaybeGetter<RegisterableHotkey | AppHotkey | null | undefined>, options?: MaybeGetter<HeldModifierOptions>) => AlpineHotkeyState<boolean>;
   /** Read live registrations, including disabled entries. */
   createHotkeyRegistrations: () => HotkeyRegistrationsResult;
   /** Read the active, exclusive, allowed, and suspended scopes through `.value`. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/alpine-hotkeys",
-  "version": "0.7.0",
+  "version": "0.9.0",
   "description": "Alpine adapter for TanStack Hotkeys",
   "author": "Tanner Linsley",
   "license": "MIT",
@@ -35,8 +35,7 @@
     "skills"
   ],
   "dependencies": {
-    "@tanstack/hotkeys": "0.19.0",
-    "@tanstack/store": "^0.11.2"
+    "@tanstack/hotkeys": "0.21.0"
   },
   "devDependencies": {
     "@types/alpinejs": "^3.17.0",