@tanstack/preact-hotkeys 0.10.0 → 0.12.0

package/README.md

@@ -1,5 +1,19 @@
 <div align="center">
-  <img src="./media/header_hotkeys.png" alt="TanStack Hotkeys" />
+  <picture>
+    <source
+      media="(prefers-color-scheme: dark)"
+      srcset="https://tanstack.com/api/readme/hotkeys.png?theme=dark"
+    />
+    <source
+      media="(prefers-color-scheme: light)"
+      srcset="https://tanstack.com/api/readme/hotkeys.png"
+    />
+    <img
+      src="https://tanstack.com/api/readme/hotkeys.png"
+      alt="TanStack Hotkeys"
+      width="900"
+    />
+  </picture>
 </div>
 
 <br />

package/dist/HotkeysProvider.d.ts

@@ -1,11 +1,9 @@
 import { UseHotkeyOptions } from "./useHotkey.js";
 import { UseHotkeySequenceOptions } from "./useHotkeySequence.js";
 import { HotkeyRecorderOptions, HotkeySequenceRecorderOptions } from "@tanstack/hotkeys";
-import * as _$preact from "preact";
 import { ComponentChildren } from "preact";
-
 //#region src/HotkeysProvider.d.ts
-interface HotkeysProviderOptions {
+export interface HotkeysProviderOptions {
   hotkey?: Partial<UseHotkeyOptions>;
   hotkeyRecorder?: Partial<HotkeyRecorderOptions>;
   hotkeySequenceRecorder?: Partial<HotkeySequenceRecorderOptions>;
@@ -14,16 +12,11 @@ interface HotkeysProviderOptions {
 interface HotkeysContextValue {
   defaultOptions: HotkeysProviderOptions;
 }
-interface HotkeysProviderProps {
+export interface HotkeysProviderProps {
   children: ComponentChildren;
   defaultOptions?: HotkeysProviderOptions;
 }
-declare function HotkeysProvider({
-  children,
-  defaultOptions
-}: HotkeysProviderProps): _$preact.JSX.Element;
-declare function useHotkeysContext(): HotkeysContextValue | null;
-declare function useDefaultHotkeysOptions(): HotkeysProviderOptions;
-//#endregion
-export { HotkeysProvider, HotkeysProviderOptions, HotkeysProviderProps, useDefaultHotkeysOptions, useHotkeysContext };
-//# sourceMappingURL=HotkeysProvider.d.ts.map
+export declare function HotkeysProvider({ children, defaultOptions }: HotkeysProviderProps): import("preact").JSX.Element;
+export declare function useHotkeysContext(): HotkeysContextValue | null;
+export declare function useDefaultHotkeysOptions(): HotkeysProviderOptions;
+//#endregion

package/dist/HotkeysProvider.js

@@ -20,5 +20,4 @@ function useDefaultHotkeysOptions() {
 }
 
 //#endregion
-export { HotkeysProvider, useDefaultHotkeysOptions, useHotkeysContext };
-//# sourceMappingURL=HotkeysProvider.js.map
+export { HotkeysProvider, useDefaultHotkeysOptions, useHotkeysContext };

package/dist/index.d.ts

@@ -9,5 +9,6 @@ import { UseHotkeySequenceDefinition, useHotkeySequences } from "./useHotkeySequ
 import { PreactHotkeyRecorder, useHotkeyRecorder } from "./useHotkeyRecorder.js";
 import { HotkeyRegistrationsResult, useHotkeyRegistrations } from "./useHotkeyRegistrations.js";
 import { PreactHotkeySequenceRecorder, useHotkeySequenceRecorder } from "./useHotkeySequenceRecorder.js";
+import { useHotkeyHint } from "./useHotkeyHint.js";
 export * from "@tanstack/hotkeys";
-export { HotkeyRegistrationsResult, HotkeysProvider, HotkeysProviderOptions, HotkeysProviderProps, PreactHotkeyRecorder, PreactHotkeySequenceRecorder, UseHotkeyDefinition, UseHotkeyOptions, UseHotkeySequenceDefinition, UseHotkeySequenceOptions, useDefaultHotkeysOptions, useHeldKeyCodes, useHeldKeys, useHotkey, useHotkeyRecorder, useHotkeyRegistrations, useHotkeySequence, useHotkeySequenceRecorder, useHotkeySequences, useHotkeys, useHotkeysContext, useKeyHold };
+export { HotkeyRegistrationsResult, HotkeysProvider, HotkeysProviderOptions, HotkeysProviderProps, PreactHotkeyRecorder, PreactHotkeySequenceRecorder, UseHotkeyDefinition, UseHotkeyOptions, UseHotkeySequenceDefinition, UseHotkeySequenceOptions, useDefaultHotkeysOptions, useHeldKeyCodes, useHeldKeys, useHotkey, useHotkeyHint, useHotkeyRecorder, useHotkeyRegistrations, useHotkeySequence, useHotkeySequenceRecorder, useHotkeySequences, useHotkeys, useHotkeysContext, useKeyHold };

package/dist/index.js

@@ -9,7 +9,8 @@ import { useHotkeySequences } from "./useHotkeySequences.js";
 import { useHotkeyRecorder } from "./useHotkeyRecorder.js";
 import { useHotkeyRegistrations } from "./useHotkeyRegistrations.js";
 import { useHotkeySequenceRecorder } from "./useHotkeySequenceRecorder.js";
+import { useHotkeyHint } from "./useHotkeyHint.js";
 
 export * from "@tanstack/hotkeys"
 
-export { HotkeysProvider, useDefaultHotkeysOptions, useHeldKeyCodes, useHeldKeys, useHotkey, useHotkeyRecorder, useHotkeyRegistrations, useHotkeySequence, useHotkeySequenceRecorder, useHotkeySequences, useHotkeys, useHotkeysContext, useKeyHold };
+export { HotkeysProvider, useDefaultHotkeysOptions, useHeldKeyCodes, useHeldKeys, useHotkey, useHotkeyHint, useHotkeyRecorder, useHotkeyRegistrations, useHotkeySequence, useHotkeySequenceRecorder, useHotkeySequences, useHotkeys, useHotkeysContext, useKeyHold };

package/dist/useHeldKeyCodes.d.ts

@@ -25,7 +25,5 @@
  * }
  * ```
  */
-declare function useHeldKeyCodes(): Record<string, string>;
-//#endregion
-export { useHeldKeyCodes };
-//# sourceMappingURL=useHeldKeyCodes.d.ts.map
+export declare function useHeldKeyCodes(): Record<string, string>;
+//#endregion

package/dist/useHeldKeyCodes.js

@@ -29,9 +29,9 @@ import { useSelector } from "@tanstack/preact-store";
 * ```
 */
 function useHeldKeyCodes() {
-	return useSelector(getKeyStateTracker().store, (state) => state.heldCodes);
+	const tracker = getKeyStateTracker();
+	return useSelector(tracker.store, (state) => state.heldCodes);
 }
 
 //#endregion
-export { useHeldKeyCodes };
-//# sourceMappingURL=useHeldKeyCodes.js.map
+export { useHeldKeyCodes };

package/dist/useHeldKeys.d.ts

@@ -21,7 +21,5 @@
  * }
  * ```
  */
-declare function useHeldKeys(): Array<string>;
-//#endregion
-export { useHeldKeys };
-//# sourceMappingURL=useHeldKeys.d.ts.map
+export declare function useHeldKeys(): Array<string>;
+//#endregion

package/dist/useHeldKeys.js

@@ -25,9 +25,9 @@ import { useSelector } from "@tanstack/preact-store";
 * ```
 */
 function useHeldKeys() {
-	return useSelector(getKeyStateTracker().store, (state) => state.heldKeys);
+	const tracker = getKeyStateTracker();
+	return useSelector(tracker.store, (state) => state.heldKeys);
 }
 
 //#endregion
-export { useHeldKeys };
-//# sourceMappingURL=useHeldKeys.js.map
+export { useHeldKeys };

package/dist/useHotkey.d.ts

@@ -1,8 +1,7 @@
 import { HotkeyCallback, HotkeyOptions, RegisterableHotkey } from "@tanstack/hotkeys";
 import { RefObject } from "preact";
-
 //#region src/useHotkey.d.ts
-interface UseHotkeyOptions extends Omit<HotkeyOptions, 'target'> {
+export interface UseHotkeyOptions extends Omit<HotkeyOptions, 'target'> {
   /**
    * The DOM element to attach the event listener to.
    * Can be a Preact ref, direct DOM element, or null.
@@ -69,7 +68,5 @@ interface UseHotkeyOptions extends Omit<HotkeyOptions, 'target'> {
  * }
  * ```
  */
-declare function useHotkey(hotkey: RegisterableHotkey, callback: HotkeyCallback, options?: UseHotkeyOptions): void;
-//#endregion
-export { UseHotkeyOptions, useHotkey };
-//# sourceMappingURL=useHotkey.d.ts.map
+export declare function useHotkey(hotkey: RegisterableHotkey, callback: HotkeyCallback, options?: UseHotkeyOptions): void;
+//#endregion

package/dist/useHotkey.js

@@ -78,7 +78,8 @@ function useHotkey(hotkey, callback, options = {}) {
 	managerRef.current = manager;
 	const prevTargetRef = useRef(null);
 	const prevHotkeyRef = useRef(null);
-	const hotkeyString = normalizeRegisterableHotkey(hotkey, mergedOptions.platform ?? detectPlatform());
+	const platform = mergedOptions.platform ?? detectPlatform();
+	const hotkeyString = normalizeRegisterableHotkey(hotkey, platform);
 	const { target: _target, ...optionsWithoutTarget } = mergedOptions;
 	useEffect(() => {
 		const resolvedTarget = isRef(optionsRef.current.target) ? optionsRef.current.target.current : optionsRef.current.target ?? (typeof document !== "undefined" ? document : null);
@@ -103,19 +104,22 @@ function useHotkey(hotkey, callback, options = {}) {
 		});
 		prevTargetRef.current = resolvedTarget;
 		prevHotkeyRef.current = hotkeyString;
+	});
+	useEffect(() => {
 		return () => {
 			if (registrationRef.current?.isActive) {
 				registrationRef.current.unregister();
 				registrationRef.current = null;
 			}
 		};
-	}, [hotkeyString]);
-	if (registrationRef.current?.isActive) {
-		registrationRef.current.callback = callback;
-		registrationRef.current.setOptions(optionsWithoutTarget);
-	}
+	}, []);
+	useEffect(() => {
+		if (registrationRef.current?.isActive) {
+			registrationRef.current.callback = callback;
+			registrationRef.current.setOptions(optionsWithoutTarget);
+		}
+	});
 }
 
 //#endregion
-export { useHotkey };
-//# sourceMappingURL=useHotkey.js.map
+export { useHotkey };

package/dist/useHotkeyHint.d.ts

@@ -0,0 +1,11 @@
+import { HeldModifierOptions, RegisterableHotkey } from "@tanstack/hotkeys";
+//#region src/useHotkeyHint.d.ts
+/**
+ * Returns a boolean indicating whether held modifiers reveal this shortcut.
+ * Only visibility changes from held-key updates cause a rerender.
+ * Uses the nonempty-subset/AltGr rules of `matchesHeldModifiers`; `exact` requires
+ * every modifier. Combine with the action's enabled state before showing a badge.
+ * This helper does not register a shortcut or check whether its target is focused.
+ */
+export declare function useHotkeyHint(hotkey: RegisterableHotkey, options?: HeldModifierOptions): boolean;
+//#endregion

package/dist/useHotkeyHint.js

@@ -0,0 +1,17 @@
+import { getKeyStateTracker, matchesHeldModifiers } from "@tanstack/hotkeys";
+import { useSelector } from "@tanstack/preact-store";
+
+//#region src/useHotkeyHint.ts
+/**
+* Returns a boolean indicating whether held modifiers reveal this shortcut.
+* Only visibility changes from held-key updates cause a rerender.
+* Uses the nonempty-subset/AltGr rules of `matchesHeldModifiers`; `exact` requires
+* every modifier. Combine with the action's enabled state before showing a badge.
+* This helper does not register a shortcut or check whether its target is focused.
+*/
+function useHotkeyHint(hotkey, options = {}) {
+	return useSelector(getKeyStateTracker().store, (state) => matchesHeldModifiers(hotkey, state.heldKeys, options));
+}
+
+//#endregion
+export { useHotkeyHint };

package/dist/useHotkeyRecorder.d.ts

@@ -1,7 +1,6 @@
 import { Hotkey, HotkeyRecorderOptions } from "@tanstack/hotkeys";
-
 //#region src/useHotkeyRecorder.d.ts
-interface PreactHotkeyRecorder {
+export interface PreactHotkeyRecorder {
   /** Whether recording is currently active */
   isRecording: boolean;
   /** The currently recorded hotkey (for live preview) */
@@ -51,7 +50,5 @@ interface PreactHotkeyRecorder {
  * }
  * ```
  */
-declare function useHotkeyRecorder(options: HotkeyRecorderOptions): PreactHotkeyRecorder;
-//#endregion
-export { PreactHotkeyRecorder, useHotkeyRecorder };
-//# sourceMappingURL=useHotkeyRecorder.d.ts.map
+export declare function useHotkeyRecorder(options: HotkeyRecorderOptions): PreactHotkeyRecorder;
+//#endregion

package/dist/useHotkeyRecorder.js

@@ -67,5 +67,4 @@ function useHotkeyRecorder(options) {
 }
 
 //#endregion
-export { useHotkeyRecorder };
-//# sourceMappingURL=useHotkeyRecorder.js.map
+export { useHotkeyRecorder };

package/dist/useHotkeyRegistrations.d.ts

@@ -1,10 +1,9 @@
 import { HotkeyRegistrationView, SequenceRegistrationView } from "@tanstack/hotkeys";
-
 //#region src/useHotkeyRegistrations.d.ts
 /**
  * Return type for useHotkeyRegistrations.
  */
-interface HotkeyRegistrationsResult {
+export interface HotkeyRegistrationsResult {
   /** All registered hotkeys (public view, no callbacks) */
   hotkeys: Array<HotkeyRegistrationView>;
   /** All registered sequences */
@@ -20,7 +19,5 @@ interface HotkeyRegistrationsResult {
  *
  * @returns Object with `hotkeys` and `sequences` arrays
  */
-declare function useHotkeyRegistrations(): HotkeyRegistrationsResult;
-//#endregion
-export { HotkeyRegistrationsResult, useHotkeyRegistrations };
-//# sourceMappingURL=useHotkeyRegistrations.d.ts.map
+export declare function useHotkeyRegistrations(): HotkeyRegistrationsResult;
+//#endregion

package/dist/useHotkeyRegistrations.js

@@ -1,4 +1,5 @@
 import { getHotkeyManager, getSequenceManager, toHotkeyRegistrationView } from "@tanstack/hotkeys";
+import { useMemo } from "preact/hooks";
 import { useSelector } from "@tanstack/preact-store";
 
 //#region src/useHotkeyRegistrations.ts
@@ -15,12 +16,13 @@ import { useSelector } from "@tanstack/preact-store";
 function useHotkeyRegistrations() {
 	const hotkeyManager = getHotkeyManager();
 	const sequenceManager = getSequenceManager();
+	const hotkeyState = useSelector(hotkeyManager.registrations);
+	const sequenceState = useSelector(sequenceManager.registrations);
 	return {
-		hotkeys: useSelector(hotkeyManager.registrations, (state) => Array.from(state.values()).map(toHotkeyRegistrationView)),
-		sequences: useSelector(sequenceManager.registrations, (state) => Array.from(state.values()))
+		hotkeys: useMemo(() => Array.from(hotkeyState.values()).map(toHotkeyRegistrationView), [hotkeyState]),
+		sequences: useMemo(() => Array.from(sequenceState.values()), [sequenceState])
 	};
 }
 
 //#endregion
-export { useHotkeyRegistrations };
-//# sourceMappingURL=useHotkeyRegistrations.js.map
+export { useHotkeyRegistrations };

package/dist/useHotkeySequence.d.ts

@@ -1,8 +1,7 @@
 import { HotkeyCallback, HotkeySequence, SequenceOptions } from "@tanstack/hotkeys";
 import { RefObject } from "preact";
-
 //#region src/useHotkeySequence.d.ts
-interface UseHotkeySequenceOptions extends Omit<SequenceOptions, 'target'> {
+export interface UseHotkeySequenceOptions extends Omit<SequenceOptions, 'target'> {
   /**
    * The DOM element to attach the event listener to.
    * Can be a Preact ref, direct DOM element, or null.
@@ -53,7 +52,5 @@ interface UseHotkeySequenceOptions extends Omit<SequenceOptions, 'target'> {
  * }
  * ```
  */
-declare function useHotkeySequence(sequence: HotkeySequence, callback: HotkeyCallback, options?: UseHotkeySequenceOptions): void;
-//#endregion
-export { UseHotkeySequenceOptions, useHotkeySequence };
-//# sourceMappingURL=useHotkeySequence.d.ts.map
+export declare function useHotkeySequence(sequence: HotkeySequence, callback: HotkeyCallback, options?: UseHotkeySequenceOptions): void;
+//#endregion

package/dist/useHotkeySequence.js

@@ -98,19 +98,22 @@ function useHotkeySequence(sequence, callback, options = {}) {
 		});
 		prevTargetRef.current = resolvedTarget;
 		prevSequenceRef.current = hotkeySequenceString;
+	});
+	useEffect(() => {
 		return () => {
 			if (registrationRef.current?.isActive) {
 				registrationRef.current.unregister();
 				registrationRef.current = null;
 			}
 		};
-	}, [hotkeySequenceString]);
-	if (registrationRef.current?.isActive) {
-		registrationRef.current.callback = (event, context) => callbackRef.current(event, context);
-		registrationRef.current.setOptions(optionsWithoutTarget);
-	}
+	}, []);
+	useEffect(() => {
+		if (registrationRef.current?.isActive) {
+			registrationRef.current.callback = (event, context) => callbackRef.current(event, context);
+			registrationRef.current.setOptions(optionsWithoutTarget);
+		}
+	});
 }
 
 //#endregion
-export { useHotkeySequence };
-//# sourceMappingURL=useHotkeySequence.js.map
+export { useHotkeySequence };

package/dist/useHotkeySequenceRecorder.d.ts

@@ -1,7 +1,6 @@
 import { HotkeySequence, HotkeySequenceRecorderOptions } from "@tanstack/hotkeys";
-
 //#region src/useHotkeySequenceRecorder.d.ts
-interface PreactHotkeySequenceRecorder {
+export interface PreactHotkeySequenceRecorder {
   isRecording: boolean;
   steps: HotkeySequence;
   recordedSequence: HotkeySequence | null;
@@ -13,7 +12,5 @@ interface PreactHotkeySequenceRecorder {
 /**
  * Preact hook for recording multi-chord sequences (Vim-style shortcuts).
  */
-declare function useHotkeySequenceRecorder(options: HotkeySequenceRecorderOptions): PreactHotkeySequenceRecorder;
-//#endregion
-export { PreactHotkeySequenceRecorder, useHotkeySequenceRecorder };
-//# sourceMappingURL=useHotkeySequenceRecorder.d.ts.map
+export declare function useHotkeySequenceRecorder(options: HotkeySequenceRecorderOptions): PreactHotkeySequenceRecorder;
+//#endregion

package/dist/useHotkeySequenceRecorder.js

@@ -35,5 +35,4 @@ function useHotkeySequenceRecorder(options) {
 }
 
 //#endregion
-export { useHotkeySequenceRecorder };
-//# sourceMappingURL=useHotkeySequenceRecorder.js.map
+export { useHotkeySequenceRecorder };

package/dist/useHotkeySequences.d.ts

@@ -1,11 +1,10 @@
 import { UseHotkeySequenceOptions } from "./useHotkeySequence.js";
 import { HotkeyCallback, HotkeySequence } from "@tanstack/hotkeys";
-
 //#region src/useHotkeySequences.d.ts
 /**
  * A single sequence definition for use with `useHotkeySequences`.
  */
-interface UseHotkeySequenceDefinition {
+export interface UseHotkeySequenceDefinition {
   /** Array of hotkey strings that form the sequence */
   sequence: HotkeySequence;
   /** The function to call when the sequence is completed */
@@ -57,7 +56,5 @@ interface UseHotkeySequenceDefinition {
  * }
  * ```
  */
-declare function useHotkeySequences(definitions: Array<UseHotkeySequenceDefinition>, commonOptions?: UseHotkeySequenceOptions): void;
-//#endregion
-export { UseHotkeySequenceDefinition, useHotkeySequences };
-//# sourceMappingURL=useHotkeySequences.d.ts.map
+export declare function useHotkeySequences(definitions: Array<UseHotkeySequenceDefinition>, commonOptions?: UseHotkeySequenceOptions): void;
+//#endregion

package/dist/useHotkeySequences.js

@@ -95,6 +95,9 @@ function useHotkeySequences(definitions, commonOptions = {}) {
 			const { registrationKey, def, seq, mergedOptions, resolvedTarget } = row;
 			const existing = prevRegistrations.get(registrationKey);
 			if (existing?.handle.isActive && existing.target === resolvedTarget) {
+				existing.handle.callback = def.callback;
+				const { target: _target, ...optionsWithoutTarget } = mergedOptions;
+				existing.handle.setOptions(optionsWithoutTarget);
 				nextRegistrations.set(registrationKey, existing);
 				continue;
 			}
@@ -116,23 +119,7 @@ function useHotkeySequences(definitions, commonOptions = {}) {
 			registrationsRef.current = /* @__PURE__ */ new Map();
 		};
 	}, []);
-	for (let i = 0; i < definitions.length; i++) {
-		const def = definitions[i];
-		const seqStr = sequenceStrings[i];
-		const registrationKey = `${i}:${seqStr}`;
-		const handle = registrationsRef.current.get(registrationKey)?.handle;
-		if (handle?.isActive && def.sequence.length > 0) {
-			handle.callback = def.callback;
-			const { target: _target, ...optionsWithoutTarget } = {
-				...defaultOptions,
-				...commonOptions,
-				...def.options
-			};
-			handle.setOptions(optionsWithoutTarget);
-		}
-	}
 }
 
 //#endregion
-export { useHotkeySequences };
-//# sourceMappingURL=useHotkeySequences.js.map
+export { useHotkeySequences };

package/dist/useHotkeys.d.ts

@@ -1,11 +1,10 @@
 import { UseHotkeyOptions } from "./useHotkey.js";
 import { HotkeyCallback, RegisterableHotkey } from "@tanstack/hotkeys";
-
 //#region src/useHotkeys.d.ts
 /**
  * A single hotkey definition for use with `useHotkeys`.
  */
-interface UseHotkeyDefinition {
+export interface UseHotkeyDefinition {
   /** The hotkey string (e.g., 'Mod+S', 'Escape') or RawHotkey object */
   hotkey: RegisterableHotkey;
   /** The function to call when the hotkey is pressed */
@@ -57,7 +56,5 @@ interface UseHotkeyDefinition {
  * }
  * ```
  */
-declare function useHotkeys(hotkeys: Array<UseHotkeyDefinition>, commonOptions?: UseHotkeyOptions): void;
-//#endregion
-export { UseHotkeyDefinition, useHotkeys };
-//# sourceMappingURL=useHotkeys.d.ts.map
+export declare function useHotkeys(hotkeys: Array<UseHotkeyDefinition>, commonOptions?: UseHotkeyOptions): void;
+//#endregion

package/dist/useHotkeys.js

@@ -93,6 +93,9 @@ function useHotkeys(hotkeys, commonOptions = {}) {
 			const { registrationKey, def, hotkeyStr, mergedOptions, resolvedTarget } = row;
 			const existing = prevRegistrations.get(registrationKey);
 			if (existing?.handle.isActive && existing.target === resolvedTarget) {
+				existing.handle.callback = def.callback;
+				const { target: _target, ...optionsWithoutTarget } = mergedOptions;
+				existing.handle.setOptions(optionsWithoutTarget);
 				nextRegistrations.set(registrationKey, existing);
 				continue;
 			}
@@ -114,23 +117,7 @@ function useHotkeys(hotkeys, commonOptions = {}) {
 			registrationsRef.current = /* @__PURE__ */ new Map();
 		};
 	}, []);
-	for (let i = 0; i < hotkeys.length; i++) {
-		const def = hotkeys[i];
-		const hotkeyStr = hotkeyStrings[i];
-		const registrationKey = `${i}:${hotkeyStr}`;
-		const handle = registrationsRef.current.get(registrationKey)?.handle;
-		if (handle?.isActive) {
-			handle.callback = def.callback;
-			const { target: _target, ...optionsWithoutTarget } = {
-				...defaultOptions,
-				...commonOptions,
-				...def.options
-			};
-			handle.setOptions(optionsWithoutTarget);
-		}
-	}
 }
 
 //#endregion
-export { useHotkeys };
-//# sourceMappingURL=useHotkeys.js.map
+export { useHotkeys };

package/dist/useKeyHold.d.ts

@@ -1,5 +1,4 @@
 import { IndividualKey } from "@tanstack/hotkeys";
-
 //#region src/useKeyHold.d.ts
 /**
  * Preact hook that returns whether a specific key is currently being held.
@@ -41,7 +40,5 @@ import { IndividualKey } from "@tanstack/hotkeys";
  * }
  * ```
  */
-declare function useKeyHold(key: IndividualKey): boolean;
-//#endregion
-export { useKeyHold };
-//# sourceMappingURL=useKeyHold.d.ts.map
+export declare function useKeyHold(key: IndividualKey): boolean;
+//#endregion

package/dist/useKeyHold.js

@@ -49,5 +49,4 @@ function useKeyHold(key) {
 }
 
 //#endregion
-export { useKeyHold };
-//# sourceMappingURL=useKeyHold.js.map
+export { useKeyHold };

package/dist/utils.js

@@ -7,5 +7,4 @@ function isRef(value) {
 }
 
 //#endregion
-export { isRef };
-//# sourceMappingURL=utils.js.map
+export { isRef };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/preact-hotkeys",
-  "version": "0.10.0",
+  "version": "0.12.0",
   "description": "Preact adapter for TanStack Hotkeys",
   "author": "Tanner Linsley",
   "license": "MIT",
@@ -20,32 +20,26 @@
     "keys"
   ],
   "type": "module",
-  "main": "./dist/index.cjs",
-  "module": "./dist/index.js",
-  "types": "./dist/index.d.cts",
+  "types": "./dist/index.d.ts",
   "exports": {
-    ".": {
-      "import": "./dist/index.js",
-      "require": "./dist/index.cjs"
-    },
+    ".": "./dist/index.js",
     "./package.json": "./package.json"
   },
   "sideEffects": false,
   "engines": {
-    "node": ">=18"
+    "node": ">=20"
   },
   "files": [
-    "dist",
-    "src"
+    "dist"
   ],
   "dependencies": {
-    "@tanstack/preact-store": "^0.13.0",
-    "@tanstack/hotkeys": "0.8.0"
+    "@tanstack/hotkeys": "0.10.0",
+    "@tanstack/preact-store": "^0.13.3"
   },
   "devDependencies": {
-    "@preact/preset-vite": "^2.10.5",
+    "@preact/preset-vite": "^2.10.6",
     "@testing-library/preact": "^3.2.4",
-    "preact": "^10.29.1"
+    "preact": "^10.29.8"
   },
   "peerDependencies": {
     "preact": ">=10.0.0"
@@ -58,6 +52,7 @@
     "test:lib": "vitest --passWithNoTests",
     "test:lib:dev": "pnpm test:lib --watch",
     "test:types": "tsc",
-    "build": "tsdown"
+    "build": "tsdown",
+    "test:build": "publint --strict && node ../../scripts/verify-package.ts"
   }
 }

package/dist/HotkeysProvider.cjs

@@ -1,26 +0,0 @@
-let preact = require("preact");
-let preact_hooks = require("preact/hooks");
-let preact_jsx_runtime = require("preact/jsx-runtime");
-
-//#region src/HotkeysProvider.tsx
-const HotkeysContext = (0, preact.createContext)(null);
-const DEFAULT_OPTIONS = {};
-function HotkeysProvider({ children, defaultOptions = DEFAULT_OPTIONS }) {
-	const contextValue = (0, preact_hooks.useMemo)(() => ({ defaultOptions }), [defaultOptions]);
-	return /* @__PURE__ */ (0, preact_jsx_runtime.jsx)(HotkeysContext.Provider, {
-		value: contextValue,
-		children
-	});
-}
-function useHotkeysContext() {
-	return (0, preact_hooks.useContext)(HotkeysContext);
-}
-function useDefaultHotkeysOptions() {
-	return (0, preact_hooks.useContext)(HotkeysContext)?.defaultOptions ?? {};
-}
-
-//#endregion
-exports.HotkeysProvider = HotkeysProvider;
-exports.useDefaultHotkeysOptions = useDefaultHotkeysOptions;
-exports.useHotkeysContext = useHotkeysContext;
-//# sourceMappingURL=HotkeysProvider.cjs.map

package/dist/HotkeysProvider.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"HotkeysProvider.cjs","names":[],"sources":["../src/HotkeysProvider.tsx"],"sourcesContent":["import { createContext } from 'preact'\nimport { useContext, useMemo } from 'preact/hooks'\nimport type { ComponentChildren } from 'preact'\nimport type {\n  HotkeyRecorderOptions,\n  HotkeySequenceRecorderOptions,\n} from '@tanstack/hotkeys'\nimport type { UseHotkeyOptions } from './useHotkey'\nimport type { UseHotkeySequenceOptions } from './useHotkeySequence'\n\nexport interface HotkeysProviderOptions {\n  hotkey?: Partial<UseHotkeyOptions>\n  hotkeyRecorder?: Partial<HotkeyRecorderOptions>\n  hotkeySequenceRecorder?: Partial<HotkeySequenceRecorderOptions>\n  hotkeySequence?: Partial<UseHotkeySequenceOptions>\n}\n\ninterface HotkeysContextValue {\n  defaultOptions: HotkeysProviderOptions\n}\n\nconst HotkeysContext = createContext<HotkeysContextValue | null>(null)\n\nexport interface HotkeysProviderProps {\n  children: ComponentChildren\n  defaultOptions?: HotkeysProviderOptions\n}\n\nconst DEFAULT_OPTIONS: HotkeysProviderOptions = {}\n\nexport function HotkeysProvider({\n  children,\n  defaultOptions = DEFAULT_OPTIONS,\n}: HotkeysProviderProps) {\n  const contextValue: HotkeysContextValue = useMemo(\n    () => ({\n      defaultOptions,\n    }),\n    [defaultOptions],\n  )\n\n  return (\n    <HotkeysContext.Provider value={contextValue}>\n      {children}\n    </HotkeysContext.Provider>\n  )\n}\n\nexport function useHotkeysContext() {\n  return useContext(HotkeysContext)\n}\n\nexport function useDefaultHotkeysOptions() {\n  const context = useContext(HotkeysContext)\n  return context?.defaultOptions ?? {}\n}\n"],"mappings":";;;;;AAqBA,MAAM,2CAA2D,KAAK;AAOtE,MAAM,kBAA0C,EAAE;AAElD,SAAgB,gBAAgB,EAC9B,UACA,iBAAiB,mBACM;CACvB,MAAM,gDACG,EACL,gBACD,GACD,CAAC,eAAe,CACjB;AAED,QACE,4CAAC,eAAe,UAAhB;EAAyB,OAAO;EAC7B;EACuB;;AAI9B,SAAgB,oBAAoB;AAClC,qCAAkB,eAAe;;AAGnC,SAAgB,2BAA2B;AAEzC,qCAD2B,eAAe,EAC1B,kBAAkB,EAAE"}