@tanstack/vue-hotkeys 0.12.0 → 0.13.0

package/README.md

@@ -67,6 +67,9 @@ Type-safe keyboard shortcuts for the web. Template-string bindings, parsed objec
 > [!NOTE]
 > You may know **TanStack Hotkeys** by our adapter names, too!
 >
+> - [**Alpine Hotkeys**](https://tanstack.com/hotkeys/latest/docs/framework/alpine/quick-start)
+> - [**Ember Hotkeys**](https://tanstack.com/hotkeys/latest/docs/framework/ember/quick-start)
+> - [**Octane Hotkeys**](https://tanstack.com/hotkeys/latest/docs/framework/octane/quick-start)
 > - [**React Hotkeys**](https://tanstack.com/hotkeys/latest/docs/framework/react/react-hotkeys)
 > - [**Preact Hotkeys**](https://tanstack.com/hotkeys/latest/docs/framework/preact/preact-hotkeys)
 > - [**Solid Hotkeys**](https://tanstack.com/hotkeys/latest/docs/framework/solid/reference)

package/dist/HotkeysProvider.js

@@ -21,7 +21,7 @@ const HotkeysProvider = defineComponent({
 		default: void 0
 	} },
 	setup(props, { slots }) {
-		provideHotkeysContext(props.defaultOptions);
+		provideHotkeysContext(() => props.defaultOptions ?? {});
 		return () => slots.default?.();
 	}
 });

package/dist/HotkeysProviderContext.d.ts

@@ -1,6 +1,7 @@
 import { UseHotkeyOptions } from "./useHotkey.js";
 import { UseHotkeySequenceOptions } from "./useHotkeySequence.js";
 import { HotkeyRecorderOptions, HotkeySequenceRecorderOptions } from "@tanstack/hotkeys";
+import { MaybeRefOrGetter } from "vue";
 //#region src/HotkeysProviderContext.d.ts
 export interface HotkeysProviderOptions {
   hotkey?: Partial<UseHotkeyOptions>;
@@ -11,7 +12,7 @@ export interface HotkeysProviderOptions {
 interface HotkeysContextValue {
   defaultOptions: HotkeysProviderOptions;
 }
-export declare function provideHotkeysContext(defaultOptions?: HotkeysProviderOptions): void;
+export declare function provideHotkeysContext(defaultOptions?: MaybeRefOrGetter<HotkeysProviderOptions>): void;
 export declare function useHotkeysContext(): HotkeysContextValue | null;
 export declare function useDefaultHotkeysOptions(): HotkeysProviderOptions;
 //#endregion

package/dist/HotkeysProviderContext.js

@@ -1,10 +1,12 @@
-import { inject, provide } from "vue";
+import { inject, provide, toValue } from "vue";
 
 //#region src/HotkeysProviderContext.ts
 const HotkeysContext = Symbol("HotkeysContext");
 const DEFAULT_OPTIONS = {};
 function provideHotkeysContext(defaultOptions) {
-	provide(HotkeysContext, { defaultOptions: defaultOptions ?? DEFAULT_OPTIONS });
+	provide(HotkeysContext, { get defaultOptions() {
+		return toValue(defaultOptions) ?? DEFAULT_OPTIONS;
+	} });
 }
 function useHotkeysContext() {
 	return inject(HotkeysContext, null);

package/dist/defaultOptions.js

@@ -0,0 +1,11 @@
+import { useHotkeysContext } from "./HotkeysProviderContext.js";
+
+//#region src/defaultOptions.ts
+/** Captures the context once and reads current defaults inside reactive computations. */
+function useDefaultHotkeysOptionsSource() {
+	const context = useHotkeysContext();
+	return () => context?.defaultOptions ?? {};
+}
+
+//#endregion
+export { useDefaultHotkeysOptionsSource };

package/dist/useHotkey.js

@@ -1,4 +1,4 @@
-import { useDefaultHotkeysOptions } from "./HotkeysProviderContext.js";
+import { useDefaultHotkeysOptionsSource } from "./defaultOptions.js";
 import { detectPlatform, getHotkeyManager, normalizeRegisterableHotkey } from "@tanstack/hotkeys";
 import { onUnmounted, unref, watch } from "vue";
 
@@ -68,7 +68,7 @@ import { onUnmounted, unref, watch } from "vue";
 * ```
 */
 function useHotkey(hotkey, callback, options = {}) {
-	const defaultOptions = useDefaultHotkeysOptions();
+	const defaultOptions = useDefaultHotkeysOptionsSource();
 	const manager = getHotkeyManager();
 	let registration = null;
 	let lastHotkeyString = null;
@@ -77,7 +77,7 @@ function useHotkey(hotkey, callback, options = {}) {
 		const resolvedHotkey = resolveMaybeRefOrGetter(hotkey);
 		const resolvedOptions = resolveMaybeRefOrGetter(options);
 		const mergedOptions = {
-			...defaultOptions.hotkey,
+			...defaultOptions().hotkey,
 			...resolvedOptions
 		};
 		return {

package/dist/useHotkeyRecorder.js

@@ -1,4 +1,4 @@
-import { useDefaultHotkeysOptions } from "./HotkeysProviderContext.js";
+import { useDefaultHotkeysOptionsSource } from "./defaultOptions.js";
 import { HotkeyRecorder } from "@tanstack/hotkeys";
 import { onUnmounted, unref, watch } from "vue";
 import { useSelector } from "@tanstack/vue-store";
@@ -46,7 +46,7 @@ import { useSelector } from "@tanstack/vue-store";
 * ```
 */
 function useHotkeyRecorder(options) {
-	const defaultOptions = useDefaultHotkeysOptions();
+	const defaultOptions = useDefaultHotkeysOptionsSource();
 	const recorder = new HotkeyRecorder(resolveRecorderOptions(options, defaultOptions));
 	const isRecording = useSelector(recorder.store, (state) => state.isRecording);
 	const recordedHotkey = useSelector(recorder.store, (state) => state.recordedHotkey);
@@ -67,7 +67,7 @@ function useHotkeyRecorder(options) {
 }
 function resolveRecorderOptions(options, defaultOptions) {
 	return {
-		...defaultOptions.hotkeyRecorder,
+		...defaultOptions().hotkeyRecorder,
 		...resolveMaybeRefOrGetter(options)
 	};
 }

package/dist/useHotkeySequence.js

@@ -1,4 +1,4 @@
-import { useDefaultHotkeysOptions } from "./HotkeysProviderContext.js";
+import { useDefaultHotkeysOptionsSource } from "./defaultOptions.js";
 import { formatHotkeySequence, getSequenceManager } from "@tanstack/hotkeys";
 import { onUnmounted, unref, watch } from "vue";
 
@@ -50,7 +50,7 @@ import { onUnmounted, unref, watch } from "vue";
 * ```
 */
 function useHotkeySequence(sequence, callback, options = {}) {
-	const defaultOptions = useDefaultHotkeysOptions();
+	const defaultOptions = useDefaultHotkeysOptionsSource();
 	const manager = getSequenceManager();
 	let registration = null;
 	let lastSequenceKey = null;
@@ -59,7 +59,7 @@ function useHotkeySequence(sequence, callback, options = {}) {
 		const resolvedSequence = resolveMaybeRefOrGetter(sequence);
 		const resolvedOptions = resolveMaybeRefOrGetter(options);
 		const mergedOptions = {
-			...defaultOptions.hotkeySequence,
+			...defaultOptions().hotkeySequence,
 			...resolvedOptions
 		};
 		return {

package/dist/useHotkeySequenceRecorder.js

@@ -1,4 +1,4 @@
-import { useDefaultHotkeysOptions } from "./HotkeysProviderContext.js";
+import { useDefaultHotkeysOptionsSource } from "./defaultOptions.js";
 import { HotkeySequenceRecorder } from "@tanstack/hotkeys";
 import { onUnmounted, unref, watch } from "vue";
 import { useSelector } from "@tanstack/vue-store";
@@ -8,7 +8,7 @@ import { useSelector } from "@tanstack/vue-store";
 * Vue composable for recording multi-chord sequences (Vim-style shortcuts).
 */
 function useHotkeySequenceRecorder(options) {
-	const defaultOptions = useDefaultHotkeysOptions();
+	const defaultOptions = useDefaultHotkeysOptionsSource();
 	const recorder = new HotkeySequenceRecorder(resolveHotkeySequenceRecorderOptions(options, defaultOptions));
 	const isRecording = useSelector(recorder.store, (state) => state.isRecording);
 	const steps = useSelector(recorder.store, (state) => state.steps);
@@ -32,7 +32,7 @@ function useHotkeySequenceRecorder(options) {
 }
 function resolveHotkeySequenceRecorderOptions(options, defaultOptions) {
 	return {
-		...defaultOptions.hotkeySequenceRecorder,
+		...defaultOptions().hotkeySequenceRecorder,
 		...resolveMaybeRefOrGetter(options)
 	};
 }

package/dist/useHotkeySequences.js

@@ -1,4 +1,4 @@
-import { useDefaultHotkeysOptions } from "./HotkeysProviderContext.js";
+import { useDefaultHotkeysOptionsSource } from "./defaultOptions.js";
 import { formatHotkeySequence, getSequenceManager } from "@tanstack/hotkeys";
 import { onUnmounted, unref, watch } from "vue";
 
@@ -48,7 +48,7 @@ import { onUnmounted, unref, watch } from "vue";
 * ```
 */
 function useHotkeySequences(definitions, commonOptions = {}) {
-	const defaultOptions = useDefaultHotkeysOptions();
+	const defaultOptions = useDefaultHotkeysOptionsSource();
 	const manager = getSequenceManager();
 	const registrations = /* @__PURE__ */ new Map();
 	const stopWatcher = watch(() => {
@@ -58,7 +58,7 @@ function useHotkeySequences(definitions, commonOptions = {}) {
 			const resolvedSequence = resolveMaybeRefOrGetter(def.sequence);
 			const resolvedDefOptions = def.options ? resolveMaybeRefOrGetter(def.options) : {};
 			const mergedOptions = {
-				...defaultOptions.hotkeySequence,
+				...defaultOptions().hotkeySequence,
 				...resolvedCommonOptions,
 				...resolvedDefOptions
 			};

package/dist/useHotkeys.js

@@ -1,4 +1,4 @@
-import { useDefaultHotkeysOptions } from "./HotkeysProviderContext.js";
+import { useDefaultHotkeysOptionsSource } from "./defaultOptions.js";
 import { detectPlatform, getHotkeyManager, normalizeRegisterableHotkey } from "@tanstack/hotkeys";
 import { onUnmounted, unref, watch } from "vue";
 
@@ -49,7 +49,7 @@ import { onUnmounted, unref, watch } from "vue";
 * ```
 */
 function useHotkeys(hotkeys, commonOptions = {}) {
-	const defaultOptions = useDefaultHotkeysOptions();
+	const defaultOptions = useDefaultHotkeysOptionsSource();
 	const manager = getHotkeyManager();
 	const registrations = /* @__PURE__ */ new Map();
 	const stopWatcher = watch(() => {
@@ -59,7 +59,7 @@ function useHotkeys(hotkeys, commonOptions = {}) {
 			const resolvedHotkey = resolveMaybeRefOrGetter(def.hotkey);
 			const resolvedDefOptions = def.options ? resolveMaybeRefOrGetter(def.options) : {};
 			const mergedOptions = {
-				...defaultOptions.hotkey,
+				...defaultOptions().hotkey,
 				...resolvedCommonOptions,
 				...resolvedDefOptions
 			};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/vue-hotkeys",
-  "version": "0.12.0",
+  "version": "0.13.0",
   "description": "Vue adapter for TanStack Hotkeys",
   "author": "Tanner Linsley",
   "license": "MIT",
@@ -36,8 +36,8 @@
     "dist"
   ],
   "dependencies": {
-    "@tanstack/hotkeys": "0.10.0",
-    "@tanstack/vue-store": "^0.11.1"
+    "@tanstack/hotkeys": "0.11.0",
+    "@tanstack/vue-store": "^0.11.2"
   },
   "devDependencies": {
     "@vitejs/plugin-vue": "^6.0.9",