@tanstack/lit-hotkeys 0.19.0 → 0.20.1

package/dist/controllers/hotkey-hint.d.ts

@@ -1,7 +1,10 @@
 import { AppHotkey, HeldModifierOptions, RegisterableHotkey } from "@tanstack/hotkeys";
 import { ReactiveController, ReactiveControllerHost } from "lit";
 //#region src/controllers/hotkey-hint.d.ts
-/** Modifier hint controller. Getter arguments can read reactive host properties. */
+/**
+ * Modifier hint controller. Getter arguments can read reactive host
+ * properties. No hotkey (`undefined`, `null`, or `''`) is never visible.
+ */
 export declare class HotkeyHintController implements ReactiveController {
   private host;
   private hotkey;
@@ -9,7 +12,7 @@ export declare class HotkeyHintController implements ReactiveController {
   private unsubscribe?;
   private visible;
   /** Attaches to the host; getter arguments can read changing reactive properties. */
-  constructor(host: ReactiveControllerHost, hotkey: RegisterableHotkey | AppHotkey | (() => RegisterableHotkey | AppHotkey), options?: HeldModifierOptions | (() => HeldModifierOptions));
+  constructor(host: ReactiveControllerHost, hotkey: RegisterableHotkey | AppHotkey | null | undefined | (() => RegisterableHotkey | AppHotkey | null | undefined), options?: HeldModifierOptions | (() => HeldModifierOptions));
   /**
    * Current visibility. True only while the hotkey can fire: some registration
    * of it is enabled and in an active scope. A hotkey on an element counts only while focus is inside it.

package/dist/controllers/hotkey-hint.js

@@ -3,7 +3,10 @@ import { isServer } from "./_server.js";
 import { getHotkeyManager, getKeyStateTracker, isAppHotkey, matchesHeldModifiers, resolveAppHotkey } from "@tanstack/hotkeys";
 
 //#region src/controllers/hotkey-hint.ts
-/** Modifier hint controller. Getter arguments can read reactive host properties. */
+/**
+* Modifier hint controller. Getter arguments can read reactive host
+* properties. No hotkey (`undefined`, `null`, or `''`) is never visible.
+*/
 var HotkeyHintController = class {
 	host;
 	hotkey;

package/dist/controllers/hotkey.d.ts

@@ -51,12 +51,12 @@ export declare class HotkeyController implements ReactiveController {
   private _unsubscribe;
   /**
    * @param host - The Lit component that owns this controller. Add the controller with `addController()`.
-   * @param hotkey - The chord, sequence, or app hotkey to register, or a getter. A getter is read on connection and after host updates.
+   * @param hotkey - The chord, sequence, or app hotkey to register, or a getter. A getter is read on connection and after host updates. `undefined`, `null`, or `''` registers nothing, for an optional shortcut.
    * @param callback - Called with the host as `this`.
    * @param options - Options or a getter. Property getters are read on connection and after host updates.
    */
-  constructor(host: ReactiveControllerHost, hotkey: MaybeGetter<AppHotkey>, callback: HotkeyCallback, options?: MaybeGetter<AppHotkeyControllerOptions>);
-  constructor(host: ReactiveControllerHost, hotkey: MaybeGetter<RegisterableHotkey>, callback: HotkeyCallback, options?: MaybeGetter<HotkeyControllerCommonOptions>);
+  constructor(host: ReactiveControllerHost, hotkey: MaybeGetter<AppHotkey | null | undefined>, callback: HotkeyCallback, options?: MaybeGetter<AppHotkeyControllerOptions>);
+  constructor(host: ReactiveControllerHost, hotkey: MaybeGetter<RegisterableHotkey | null | undefined>, callback: HotkeyCallback, options?: MaybeGetter<HotkeyControllerCommonOptions>);
   /** Registers when connected and a target is available. */
   hostConnected(): void;
   /** Refreshes options after rendering, when scoped targets are available. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/lit-hotkeys",
-  "version": "0.19.0",
+  "version": "0.20.1",
   "description": "Lit adapter for TanStack Hotkeys",
   "author": "Tanner Linsley",
   "license": "MIT",
@@ -35,7 +35,7 @@
     "skills"
   ],
   "dependencies": {
-    "@tanstack/hotkeys": "0.20.0"
+    "@tanstack/hotkeys": "0.22.0"
   },
   "devDependencies": {
     "lit": "^3.3.3"