@tanstack/vue-hotkeys 0.5.1 → 0.6.0

package/dist/HotkeysProviderContext.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"HotkeysProviderContext.cjs","names":[],"sources":["../src/HotkeysProviderContext.ts"],"sourcesContent":["import { inject, provide } from 'vue'\nimport type { InjectionKey } from 'vue'\nimport type { HotkeyRecorderOptions } 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  hotkeySequence?: Partial<UseHotkeySequenceOptions>\n}\n\ninterface HotkeysContextValue {\n  defaultOptions: HotkeysProviderOptions\n}\n\nconst HotkeysContext: InjectionKey<HotkeysContextValue> =\n  Symbol('HotkeysContext')\n\nconst DEFAULT_OPTIONS: HotkeysProviderOptions = {}\n\nexport function provideHotkeysContext(defaultOptions?: HotkeysProviderOptions) {\n  const contextValue: HotkeysContextValue = {\n    defaultOptions: defaultOptions ?? DEFAULT_OPTIONS,\n  }\n\n  provide(HotkeysContext, contextValue)\n}\n\nexport function useHotkeysContext() {\n  return inject(HotkeysContext, null)\n}\n\nexport function useDefaultHotkeysOptions() {\n  const context = inject(HotkeysContext, null)\n  return context?.defaultOptions ?? {}\n}\n"],"mappings":";;;AAgBA,MAAM,iBACJ,OAAO,iBAAiB;AAE1B,MAAM,kBAA0C,EAAE;AAElD,SAAgB,sBAAsB,gBAAyC;AAK7E,kBAAQ,gBAJkC,EACxC,gBAAgB,kBAAkB,iBACnC,CAEoC;;AAGvC,SAAgB,oBAAoB;AAClC,wBAAc,gBAAgB,KAAK;;AAGrC,SAAgB,2BAA2B;AAEzC,wBADuB,gBAAgB,KAAK,EAC5B,kBAAkB,EAAE"}
+{"version":3,"file":"HotkeysProviderContext.cjs","names":[],"sources":["../src/HotkeysProviderContext.ts"],"sourcesContent":["import { inject, provide } from 'vue'\nimport type { InjectionKey } from 'vue'\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: InjectionKey<HotkeysContextValue> =\n  Symbol('HotkeysContext')\n\nconst DEFAULT_OPTIONS: HotkeysProviderOptions = {}\n\nexport function provideHotkeysContext(defaultOptions?: HotkeysProviderOptions) {\n  const contextValue: HotkeysContextValue = {\n    defaultOptions: defaultOptions ?? DEFAULT_OPTIONS,\n  }\n\n  provide(HotkeysContext, contextValue)\n}\n\nexport function useHotkeysContext() {\n  return inject(HotkeysContext, null)\n}\n\nexport function useDefaultHotkeysOptions() {\n  const context = inject(HotkeysContext, null)\n  return context?.defaultOptions ?? {}\n}\n"],"mappings":";;;AAoBA,MAAM,iBACJ,OAAO,iBAAiB;AAE1B,MAAM,kBAA0C,EAAE;AAElD,SAAgB,sBAAsB,gBAAyC;AAK7E,kBAAQ,gBAJkC,EACxC,gBAAgB,kBAAkB,iBACnC,CAEoC;;AAGvC,SAAgB,oBAAoB;AAClC,wBAAc,gBAAgB,KAAK;;AAGrC,SAAgB,2BAA2B;AAEzC,wBADuB,gBAAgB,KAAK,EAC5B,kBAAkB,EAAE"}

package/dist/HotkeysProviderContext.d.cts

@@ -1,11 +1,12 @@
 import { UseHotkeyOptions } from "./useHotkey.cjs";
 import { UseHotkeySequenceOptions } from "./useHotkeySequence.cjs";
-import { HotkeyRecorderOptions } from "@tanstack/hotkeys";
+import { HotkeyRecorderOptions, HotkeySequenceRecorderOptions } from "@tanstack/hotkeys";
 
 //#region src/HotkeysProviderContext.d.ts
 interface HotkeysProviderOptions {
   hotkey?: Partial<UseHotkeyOptions>;
   hotkeyRecorder?: Partial<HotkeyRecorderOptions>;
+  hotkeySequenceRecorder?: Partial<HotkeySequenceRecorderOptions>;
   hotkeySequence?: Partial<UseHotkeySequenceOptions>;
 }
 interface HotkeysContextValue {

package/dist/HotkeysProviderContext.d.ts

@@ -1,11 +1,12 @@
 import { UseHotkeyOptions } from "./useHotkey.js";
 import { UseHotkeySequenceOptions } from "./useHotkeySequence.js";
-import { HotkeyRecorderOptions } from "@tanstack/hotkeys";
+import { HotkeyRecorderOptions, HotkeySequenceRecorderOptions } from "@tanstack/hotkeys";
 
 //#region src/HotkeysProviderContext.d.ts
 interface HotkeysProviderOptions {
   hotkey?: Partial<UseHotkeyOptions>;
   hotkeyRecorder?: Partial<HotkeyRecorderOptions>;
+  hotkeySequenceRecorder?: Partial<HotkeySequenceRecorderOptions>;
   hotkeySequence?: Partial<UseHotkeySequenceOptions>;
 }
 interface HotkeysContextValue {

package/dist/HotkeysProviderContext.js.map

@@ -1 +1 @@
-{"version":3,"file":"HotkeysProviderContext.js","names":[],"sources":["../src/HotkeysProviderContext.ts"],"sourcesContent":["import { inject, provide } from 'vue'\nimport type { InjectionKey } from 'vue'\nimport type { HotkeyRecorderOptions } 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  hotkeySequence?: Partial<UseHotkeySequenceOptions>\n}\n\ninterface HotkeysContextValue {\n  defaultOptions: HotkeysProviderOptions\n}\n\nconst HotkeysContext: InjectionKey<HotkeysContextValue> =\n  Symbol('HotkeysContext')\n\nconst DEFAULT_OPTIONS: HotkeysProviderOptions = {}\n\nexport function provideHotkeysContext(defaultOptions?: HotkeysProviderOptions) {\n  const contextValue: HotkeysContextValue = {\n    defaultOptions: defaultOptions ?? DEFAULT_OPTIONS,\n  }\n\n  provide(HotkeysContext, contextValue)\n}\n\nexport function useHotkeysContext() {\n  return inject(HotkeysContext, null)\n}\n\nexport function useDefaultHotkeysOptions() {\n  const context = inject(HotkeysContext, null)\n  return context?.defaultOptions ?? {}\n}\n"],"mappings":";;;AAgBA,MAAM,iBACJ,OAAO,iBAAiB;AAE1B,MAAM,kBAA0C,EAAE;AAElD,SAAgB,sBAAsB,gBAAyC;AAK7E,SAAQ,gBAJkC,EACxC,gBAAgB,kBAAkB,iBACnC,CAEoC;;AAGvC,SAAgB,oBAAoB;AAClC,QAAO,OAAO,gBAAgB,KAAK;;AAGrC,SAAgB,2BAA2B;AAEzC,QADgB,OAAO,gBAAgB,KAAK,EAC5B,kBAAkB,EAAE"}
+{"version":3,"file":"HotkeysProviderContext.js","names":[],"sources":["../src/HotkeysProviderContext.ts"],"sourcesContent":["import { inject, provide } from 'vue'\nimport type { InjectionKey } from 'vue'\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: InjectionKey<HotkeysContextValue> =\n  Symbol('HotkeysContext')\n\nconst DEFAULT_OPTIONS: HotkeysProviderOptions = {}\n\nexport function provideHotkeysContext(defaultOptions?: HotkeysProviderOptions) {\n  const contextValue: HotkeysContextValue = {\n    defaultOptions: defaultOptions ?? DEFAULT_OPTIONS,\n  }\n\n  provide(HotkeysContext, contextValue)\n}\n\nexport function useHotkeysContext() {\n  return inject(HotkeysContext, null)\n}\n\nexport function useDefaultHotkeysOptions() {\n  const context = inject(HotkeysContext, null)\n  return context?.defaultOptions ?? {}\n}\n"],"mappings":";;;AAoBA,MAAM,iBACJ,OAAO,iBAAiB;AAE1B,MAAM,kBAA0C,EAAE;AAElD,SAAgB,sBAAsB,gBAAyC;AAK7E,SAAQ,gBAJkC,EACxC,gBAAgB,kBAAkB,iBACnC,CAEoC;;AAGvC,SAAgB,oBAAoB;AAClC,QAAO,OAAO,gBAAgB,KAAK;;AAGrC,SAAgB,2BAA2B;AAEzC,QADgB,OAAO,gBAAgB,KAAK,EAC5B,kBAAkB,EAAE"}

package/dist/index.cjs

@@ -8,6 +8,7 @@ const require_useHeldKeyCodes = require('./useHeldKeyCodes.cjs');
 const require_useKeyHold = require('./useKeyHold.cjs');
 const require_useHotkeySequence = require('./useHotkeySequence.cjs');
 const require_useHotkeyRecorder = require('./useHotkeyRecorder.cjs');
+const require_useHotkeySequenceRecorder = require('./useHotkeySequenceRecorder.cjs');
 
 exports.HotkeysProvider = require_HotkeysProvider.HotkeysProvider;
 exports.provideHotkeysContext = require_HotkeysProviderContext.provideHotkeysContext;
@@ -17,6 +18,7 @@ exports.useHeldKeys = require_useHeldKeys.useHeldKeys;
 exports.useHotkey = require_useHotkey.useHotkey;
 exports.useHotkeyRecorder = require_useHotkeyRecorder.useHotkeyRecorder;
 exports.useHotkeySequence = require_useHotkeySequence.useHotkeySequence;
+exports.useHotkeySequenceRecorder = require_useHotkeySequenceRecorder.useHotkeySequenceRecorder;
 exports.useHotkeys = require_useHotkeys.useHotkeys;
 exports.useHotkeysContext = require_HotkeysProviderContext.useHotkeysContext;
 exports.useKeyHold = require_useKeyHold.useKeyHold;

package/dist/index.d.cts

@@ -7,5 +7,6 @@ import { useHeldKeys } from "./useHeldKeys.cjs";
 import { useHeldKeyCodes } from "./useHeldKeyCodes.cjs";
 import { useKeyHold } from "./useKeyHold.cjs";
 import { VueHotkeyRecorder, useHotkeyRecorder } from "./useHotkeyRecorder.cjs";
+import { VueHotkeySequenceRecorder, useHotkeySequenceRecorder } from "./useHotkeySequenceRecorder.cjs";
 export * from "@tanstack/hotkeys";
-export { HotkeysProvider, HotkeysProviderOptions, UseHotkeyDefinition, UseHotkeyOptions, UseHotkeySequenceOptions, VueHotkeyRecorder, provideHotkeysContext, useDefaultHotkeysOptions, useHeldKeyCodes, useHeldKeys, useHotkey, useHotkeyRecorder, useHotkeySequence, useHotkeys, useHotkeysContext, useKeyHold };
+export { HotkeysProvider, HotkeysProviderOptions, UseHotkeyDefinition, UseHotkeyOptions, UseHotkeySequenceOptions, VueHotkeyRecorder, VueHotkeySequenceRecorder, provideHotkeysContext, useDefaultHotkeysOptions, useHeldKeyCodes, useHeldKeys, useHotkey, useHotkeyRecorder, useHotkeySequence, useHotkeySequenceRecorder, useHotkeys, useHotkeysContext, useKeyHold };

package/dist/index.d.ts

@@ -7,5 +7,6 @@ import { useHeldKeys } from "./useHeldKeys.js";
 import { useHeldKeyCodes } from "./useHeldKeyCodes.js";
 import { useKeyHold } from "./useKeyHold.js";
 import { VueHotkeyRecorder, useHotkeyRecorder } from "./useHotkeyRecorder.js";
+import { VueHotkeySequenceRecorder, useHotkeySequenceRecorder } from "./useHotkeySequenceRecorder.js";
 export * from "@tanstack/hotkeys";
-export { HotkeysProvider, HotkeysProviderOptions, UseHotkeyDefinition, UseHotkeyOptions, UseHotkeySequenceOptions, VueHotkeyRecorder, provideHotkeysContext, useDefaultHotkeysOptions, useHeldKeyCodes, useHeldKeys, useHotkey, useHotkeyRecorder, useHotkeySequence, useHotkeys, useHotkeysContext, useKeyHold };
+export { HotkeysProvider, HotkeysProviderOptions, UseHotkeyDefinition, UseHotkeyOptions, UseHotkeySequenceOptions, VueHotkeyRecorder, VueHotkeySequenceRecorder, provideHotkeysContext, useDefaultHotkeysOptions, useHeldKeyCodes, useHeldKeys, useHotkey, useHotkeyRecorder, useHotkeySequence, useHotkeySequenceRecorder, useHotkeys, useHotkeysContext, useKeyHold };

package/dist/index.js

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

package/dist/useHotkeySequenceRecorder.cjs

@@ -0,0 +1,45 @@
+const require_HotkeysProviderContext = require('./HotkeysProviderContext.cjs');
+let _tanstack_hotkeys = require("@tanstack/hotkeys");
+let vue = require("vue");
+let _tanstack_vue_store = require("@tanstack/vue-store");
+
+//#region src/useHotkeySequenceRecorder.ts
+/**
+* Vue composable for recording multi-chord sequences (Vim-style shortcuts).
+*/
+function useHotkeySequenceRecorder(options) {
+	const defaultOptions = require_HotkeysProviderContext.useDefaultHotkeysOptions();
+	const recorder = new _tanstack_hotkeys.HotkeySequenceRecorder(resolveHotkeySequenceRecorderOptions(options, defaultOptions));
+	const isRecording = (0, _tanstack_vue_store.useStore)(recorder.store, (state) => state.isRecording);
+	const steps = (0, _tanstack_vue_store.useStore)(recorder.store, (state) => state.steps);
+	const recordedSequence = (0, _tanstack_vue_store.useStore)(recorder.store, (state) => state.recordedSequence);
+	const stopWatcher = (0, vue.watch)(() => resolveHotkeySequenceRecorderOptions(options, defaultOptions), (resolvedOptions) => {
+		recorder.setOptions(resolvedOptions);
+	}, { immediate: true });
+	(0, vue.onUnmounted)(() => {
+		stopWatcher();
+		recorder.destroy();
+	});
+	return {
+		isRecording,
+		steps,
+		recordedSequence,
+		startRecording: () => recorder.start(),
+		stopRecording: () => recorder.stop(),
+		cancelRecording: () => recorder.cancel(),
+		commitRecording: () => recorder.commit()
+	};
+}
+function resolveHotkeySequenceRecorderOptions(options, defaultOptions) {
+	return {
+		...defaultOptions.hotkeySequenceRecorder,
+		...resolveMaybeRefOrGetter(options)
+	};
+}
+function resolveMaybeRefOrGetter(value) {
+	return typeof value === "function" ? value() : (0, vue.unref)(value);
+}
+
+//#endregion
+exports.useHotkeySequenceRecorder = useHotkeySequenceRecorder;
+//# sourceMappingURL=useHotkeySequenceRecorder.cjs.map

package/dist/useHotkeySequenceRecorder.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"useHotkeySequenceRecorder.cjs","names":["useDefaultHotkeysOptions","HotkeySequenceRecorder"],"sources":["../src/useHotkeySequenceRecorder.ts"],"sourcesContent":["import { onUnmounted, unref, watch } from 'vue'\nimport { useStore } from '@tanstack/vue-store'\nimport { HotkeySequenceRecorder } from '@tanstack/hotkeys'\nimport { useDefaultHotkeysOptions } from './HotkeysProviderContext'\nimport type { MaybeRefOrGetter, Ref } from 'vue'\nimport type {\n  HotkeySequence,\n  HotkeySequenceRecorderOptions,\n} from '@tanstack/hotkeys'\n\nexport interface VueHotkeySequenceRecorder {\n  isRecording: Ref<boolean>\n  steps: Ref<HotkeySequence>\n  recordedSequence: Ref<HotkeySequence | null>\n  startRecording: () => void\n  stopRecording: () => void\n  cancelRecording: () => void\n  commitRecording: () => void\n}\n\n/**\n * Vue composable for recording multi-chord sequences (Vim-style shortcuts).\n */\nexport function useHotkeySequenceRecorder(\n  options: MaybeRefOrGetter<HotkeySequenceRecorderOptions>,\n): VueHotkeySequenceRecorder {\n  const defaultOptions = useDefaultHotkeysOptions()\n  const recorder = new HotkeySequenceRecorder(\n    resolveHotkeySequenceRecorderOptions(options, defaultOptions),\n  )\n\n  const isRecording = useStore(recorder.store, (state) => state.isRecording)\n  const steps = useStore(recorder.store, (state) => state.steps)\n  const recordedSequence = useStore(\n    recorder.store,\n    (state) => state.recordedSequence,\n  )\n\n  const stopWatcher = watch(\n    () => resolveHotkeySequenceRecorderOptions(options, defaultOptions),\n    (resolvedOptions) => {\n      recorder.setOptions(resolvedOptions)\n    },\n    { immediate: true },\n  )\n\n  onUnmounted(() => {\n    stopWatcher()\n    recorder.destroy()\n  })\n\n  return {\n    isRecording: isRecording as Ref<boolean>,\n    steps: steps as Ref<HotkeySequence>,\n    recordedSequence: recordedSequence as Ref<HotkeySequence | null>,\n    startRecording: () => recorder.start(),\n    stopRecording: () => recorder.stop(),\n    cancelRecording: () => recorder.cancel(),\n    commitRecording: () => recorder.commit(),\n  }\n}\n\nfunction resolveHotkeySequenceRecorderOptions(\n  options: MaybeRefOrGetter<HotkeySequenceRecorderOptions>,\n  defaultOptions: ReturnType<typeof useDefaultHotkeysOptions>,\n): HotkeySequenceRecorderOptions {\n  return {\n    ...defaultOptions.hotkeySequenceRecorder,\n    ...resolveMaybeRefOrGetter(options),\n  } as HotkeySequenceRecorderOptions\n}\n\nfunction resolveMaybeRefOrGetter<T>(value: MaybeRefOrGetter<T>): T {\n  return typeof value === 'function' ? (value as () => T)() : unref(value)\n}\n"],"mappings":";;;;;;;;;AAuBA,SAAgB,0BACd,SAC2B;CAC3B,MAAM,iBAAiBA,yDAA0B;CACjD,MAAM,WAAW,IAAIC,yCACnB,qCAAqC,SAAS,eAAe,CAC9D;CAED,MAAM,gDAAuB,SAAS,QAAQ,UAAU,MAAM,YAAY;CAC1E,MAAM,0CAAiB,SAAS,QAAQ,UAAU,MAAM,MAAM;CAC9D,MAAM,qDACJ,SAAS,QACR,UAAU,MAAM,iBAClB;CAED,MAAM,mCACE,qCAAqC,SAAS,eAAe,GAClE,oBAAoB;AACnB,WAAS,WAAW,gBAAgB;IAEtC,EAAE,WAAW,MAAM,CACpB;AAED,4BAAkB;AAChB,eAAa;AACb,WAAS,SAAS;GAClB;AAEF,QAAO;EACQ;EACN;EACW;EAClB,sBAAsB,SAAS,OAAO;EACtC,qBAAqB,SAAS,MAAM;EACpC,uBAAuB,SAAS,QAAQ;EACxC,uBAAuB,SAAS,QAAQ;EACzC;;AAGH,SAAS,qCACP,SACA,gBAC+B;AAC/B,QAAO;EACL,GAAG,eAAe;EAClB,GAAG,wBAAwB,QAAQ;EACpC;;AAGH,SAAS,wBAA2B,OAA+B;AACjE,QAAO,OAAO,UAAU,aAAc,OAAmB,kBAAS,MAAM"}

package/dist/useHotkeySequenceRecorder.d.cts

@@ -0,0 +1,20 @@
+import { HotkeySequence, HotkeySequenceRecorderOptions } from "@tanstack/hotkeys";
+import { MaybeRefOrGetter, Ref } from "vue";
+
+//#region src/useHotkeySequenceRecorder.d.ts
+interface VueHotkeySequenceRecorder {
+  isRecording: Ref<boolean>;
+  steps: Ref<HotkeySequence>;
+  recordedSequence: Ref<HotkeySequence | null>;
+  startRecording: () => void;
+  stopRecording: () => void;
+  cancelRecording: () => void;
+  commitRecording: () => void;
+}
+/**
+ * Vue composable for recording multi-chord sequences (Vim-style shortcuts).
+ */
+declare function useHotkeySequenceRecorder(options: MaybeRefOrGetter<HotkeySequenceRecorderOptions>): VueHotkeySequenceRecorder;
+//#endregion
+export { VueHotkeySequenceRecorder, useHotkeySequenceRecorder };
+//# sourceMappingURL=useHotkeySequenceRecorder.d.cts.map

package/dist/useHotkeySequenceRecorder.d.ts

@@ -0,0 +1,20 @@
+import { HotkeySequence, HotkeySequenceRecorderOptions } from "@tanstack/hotkeys";
+import { MaybeRefOrGetter, Ref } from "vue";
+
+//#region src/useHotkeySequenceRecorder.d.ts
+interface VueHotkeySequenceRecorder {
+  isRecording: Ref<boolean>;
+  steps: Ref<HotkeySequence>;
+  recordedSequence: Ref<HotkeySequence | null>;
+  startRecording: () => void;
+  stopRecording: () => void;
+  cancelRecording: () => void;
+  commitRecording: () => void;
+}
+/**
+ * Vue composable for recording multi-chord sequences (Vim-style shortcuts).
+ */
+declare function useHotkeySequenceRecorder(options: MaybeRefOrGetter<HotkeySequenceRecorderOptions>): VueHotkeySequenceRecorder;
+//#endregion
+export { VueHotkeySequenceRecorder, useHotkeySequenceRecorder };
+//# sourceMappingURL=useHotkeySequenceRecorder.d.ts.map

package/dist/useHotkeySequenceRecorder.js

@@ -0,0 +1,45 @@
+import { useDefaultHotkeysOptions } from "./HotkeysProviderContext.js";
+import { HotkeySequenceRecorder } from "@tanstack/hotkeys";
+import { onUnmounted, unref, watch } from "vue";
+import { useStore } from "@tanstack/vue-store";
+
+//#region src/useHotkeySequenceRecorder.ts
+/**
+* Vue composable for recording multi-chord sequences (Vim-style shortcuts).
+*/
+function useHotkeySequenceRecorder(options) {
+	const defaultOptions = useDefaultHotkeysOptions();
+	const recorder = new HotkeySequenceRecorder(resolveHotkeySequenceRecorderOptions(options, defaultOptions));
+	const isRecording = useStore(recorder.store, (state) => state.isRecording);
+	const steps = useStore(recorder.store, (state) => state.steps);
+	const recordedSequence = useStore(recorder.store, (state) => state.recordedSequence);
+	const stopWatcher = watch(() => resolveHotkeySequenceRecorderOptions(options, defaultOptions), (resolvedOptions) => {
+		recorder.setOptions(resolvedOptions);
+	}, { immediate: true });
+	onUnmounted(() => {
+		stopWatcher();
+		recorder.destroy();
+	});
+	return {
+		isRecording,
+		steps,
+		recordedSequence,
+		startRecording: () => recorder.start(),
+		stopRecording: () => recorder.stop(),
+		cancelRecording: () => recorder.cancel(),
+		commitRecording: () => recorder.commit()
+	};
+}
+function resolveHotkeySequenceRecorderOptions(options, defaultOptions) {
+	return {
+		...defaultOptions.hotkeySequenceRecorder,
+		...resolveMaybeRefOrGetter(options)
+	};
+}
+function resolveMaybeRefOrGetter(value) {
+	return typeof value === "function" ? value() : unref(value);
+}
+
+//#endregion
+export { useHotkeySequenceRecorder };
+//# sourceMappingURL=useHotkeySequenceRecorder.js.map

package/dist/useHotkeySequenceRecorder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useHotkeySequenceRecorder.js","names":[],"sources":["../src/useHotkeySequenceRecorder.ts"],"sourcesContent":["import { onUnmounted, unref, watch } from 'vue'\nimport { useStore } from '@tanstack/vue-store'\nimport { HotkeySequenceRecorder } from '@tanstack/hotkeys'\nimport { useDefaultHotkeysOptions } from './HotkeysProviderContext'\nimport type { MaybeRefOrGetter, Ref } from 'vue'\nimport type {\n  HotkeySequence,\n  HotkeySequenceRecorderOptions,\n} from '@tanstack/hotkeys'\n\nexport interface VueHotkeySequenceRecorder {\n  isRecording: Ref<boolean>\n  steps: Ref<HotkeySequence>\n  recordedSequence: Ref<HotkeySequence | null>\n  startRecording: () => void\n  stopRecording: () => void\n  cancelRecording: () => void\n  commitRecording: () => void\n}\n\n/**\n * Vue composable for recording multi-chord sequences (Vim-style shortcuts).\n */\nexport function useHotkeySequenceRecorder(\n  options: MaybeRefOrGetter<HotkeySequenceRecorderOptions>,\n): VueHotkeySequenceRecorder {\n  const defaultOptions = useDefaultHotkeysOptions()\n  const recorder = new HotkeySequenceRecorder(\n    resolveHotkeySequenceRecorderOptions(options, defaultOptions),\n  )\n\n  const isRecording = useStore(recorder.store, (state) => state.isRecording)\n  const steps = useStore(recorder.store, (state) => state.steps)\n  const recordedSequence = useStore(\n    recorder.store,\n    (state) => state.recordedSequence,\n  )\n\n  const stopWatcher = watch(\n    () => resolveHotkeySequenceRecorderOptions(options, defaultOptions),\n    (resolvedOptions) => {\n      recorder.setOptions(resolvedOptions)\n    },\n    { immediate: true },\n  )\n\n  onUnmounted(() => {\n    stopWatcher()\n    recorder.destroy()\n  })\n\n  return {\n    isRecording: isRecording as Ref<boolean>,\n    steps: steps as Ref<HotkeySequence>,\n    recordedSequence: recordedSequence as Ref<HotkeySequence | null>,\n    startRecording: () => recorder.start(),\n    stopRecording: () => recorder.stop(),\n    cancelRecording: () => recorder.cancel(),\n    commitRecording: () => recorder.commit(),\n  }\n}\n\nfunction resolveHotkeySequenceRecorderOptions(\n  options: MaybeRefOrGetter<HotkeySequenceRecorderOptions>,\n  defaultOptions: ReturnType<typeof useDefaultHotkeysOptions>,\n): HotkeySequenceRecorderOptions {\n  return {\n    ...defaultOptions.hotkeySequenceRecorder,\n    ...resolveMaybeRefOrGetter(options),\n  } as HotkeySequenceRecorderOptions\n}\n\nfunction resolveMaybeRefOrGetter<T>(value: MaybeRefOrGetter<T>): T {\n  return typeof value === 'function' ? (value as () => T)() : unref(value)\n}\n"],"mappings":";;;;;;;;;AAuBA,SAAgB,0BACd,SAC2B;CAC3B,MAAM,iBAAiB,0BAA0B;CACjD,MAAM,WAAW,IAAI,uBACnB,qCAAqC,SAAS,eAAe,CAC9D;CAED,MAAM,cAAc,SAAS,SAAS,QAAQ,UAAU,MAAM,YAAY;CAC1E,MAAM,QAAQ,SAAS,SAAS,QAAQ,UAAU,MAAM,MAAM;CAC9D,MAAM,mBAAmB,SACvB,SAAS,QACR,UAAU,MAAM,iBAClB;CAED,MAAM,cAAc,YACZ,qCAAqC,SAAS,eAAe,GAClE,oBAAoB;AACnB,WAAS,WAAW,gBAAgB;IAEtC,EAAE,WAAW,MAAM,CACpB;AAED,mBAAkB;AAChB,eAAa;AACb,WAAS,SAAS;GAClB;AAEF,QAAO;EACQ;EACN;EACW;EAClB,sBAAsB,SAAS,OAAO;EACtC,qBAAqB,SAAS,MAAM;EACpC,uBAAuB,SAAS,QAAQ;EACxC,uBAAuB,SAAS,QAAQ;EACzC;;AAGH,SAAS,qCACP,SACA,gBAC+B;AAC/B,QAAO;EACL,GAAG,eAAe;EAClB,GAAG,wBAAwB,QAAQ;EACpC;;AAGH,SAAS,wBAA2B,OAA+B;AACjE,QAAO,OAAO,UAAU,aAAc,OAAmB,GAAG,MAAM,MAAM"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/vue-hotkeys",
-  "version": "0.5.1",
+  "version": "0.6.0",
   "description": "Vue adapter for TanStack Hotkeys",
   "author": "Tanner Linsley",
   "license": "MIT",
@@ -43,7 +43,7 @@
   ],
   "dependencies": {
     "@tanstack/vue-store": "^0.9.2",
-    "@tanstack/hotkeys": "0.4.3"
+    "@tanstack/hotkeys": "0.5.0"
   },
   "devDependencies": {
     "@vitejs/plugin-vue": "^6.0.5",

package/src/HotkeysProviderContext.ts

@@ -1,12 +1,16 @@
 import { inject, provide } from 'vue'
 import type { InjectionKey } from 'vue'
-import type { HotkeyRecorderOptions } from '@tanstack/hotkeys'
+import type {
+  HotkeyRecorderOptions,
+  HotkeySequenceRecorderOptions,
+} from '@tanstack/hotkeys'
 import type { UseHotkeyOptions } from './useHotkey'
 import type { UseHotkeySequenceOptions } from './useHotkeySequence'
 
 export interface HotkeysProviderOptions {
   hotkey?: Partial<UseHotkeyOptions>
   hotkeyRecorder?: Partial<HotkeyRecorderOptions>
+  hotkeySequenceRecorder?: Partial<HotkeySequenceRecorderOptions>
   hotkeySequence?: Partial<UseHotkeySequenceOptions>
 }
 

package/src/index.ts

@@ -13,3 +13,4 @@ export * from './useHeldKeyCodes'
 export * from './useKeyHold'
 export * from './useHotkeySequence'
 export * from './useHotkeyRecorder'
+export * from './useHotkeySequenceRecorder'

package/src/useHotkeySequenceRecorder.ts

@@ -0,0 +1,75 @@
+import { onUnmounted, unref, watch } from 'vue'
+import { useStore } from '@tanstack/vue-store'
+import { HotkeySequenceRecorder } from '@tanstack/hotkeys'
+import { useDefaultHotkeysOptions } from './HotkeysProviderContext'
+import type { MaybeRefOrGetter, Ref } from 'vue'
+import type {
+  HotkeySequence,
+  HotkeySequenceRecorderOptions,
+} from '@tanstack/hotkeys'
+
+export interface VueHotkeySequenceRecorder {
+  isRecording: Ref<boolean>
+  steps: Ref<HotkeySequence>
+  recordedSequence: Ref<HotkeySequence | null>
+  startRecording: () => void
+  stopRecording: () => void
+  cancelRecording: () => void
+  commitRecording: () => void
+}
+
+/**
+ * Vue composable for recording multi-chord sequences (Vim-style shortcuts).
+ */
+export function useHotkeySequenceRecorder(
+  options: MaybeRefOrGetter<HotkeySequenceRecorderOptions>,
+): VueHotkeySequenceRecorder {
+  const defaultOptions = useDefaultHotkeysOptions()
+  const recorder = new HotkeySequenceRecorder(
+    resolveHotkeySequenceRecorderOptions(options, defaultOptions),
+  )
+
+  const isRecording = useStore(recorder.store, (state) => state.isRecording)
+  const steps = useStore(recorder.store, (state) => state.steps)
+  const recordedSequence = useStore(
+    recorder.store,
+    (state) => state.recordedSequence,
+  )
+
+  const stopWatcher = watch(
+    () => resolveHotkeySequenceRecorderOptions(options, defaultOptions),
+    (resolvedOptions) => {
+      recorder.setOptions(resolvedOptions)
+    },
+    { immediate: true },
+  )
+
+  onUnmounted(() => {
+    stopWatcher()
+    recorder.destroy()
+  })
+
+  return {
+    isRecording: isRecording as Ref<boolean>,
+    steps: steps as Ref<HotkeySequence>,
+    recordedSequence: recordedSequence as Ref<HotkeySequence | null>,
+    startRecording: () => recorder.start(),
+    stopRecording: () => recorder.stop(),
+    cancelRecording: () => recorder.cancel(),
+    commitRecording: () => recorder.commit(),
+  }
+}
+
+function resolveHotkeySequenceRecorderOptions(
+  options: MaybeRefOrGetter<HotkeySequenceRecorderOptions>,
+  defaultOptions: ReturnType<typeof useDefaultHotkeysOptions>,
+): HotkeySequenceRecorderOptions {
+  return {
+    ...defaultOptions.hotkeySequenceRecorder,
+    ...resolveMaybeRefOrGetter(options),
+  } as HotkeySequenceRecorderOptions
+}
+
+function resolveMaybeRefOrGetter<T>(value: MaybeRefOrGetter<T>): T {
+  return typeof value === 'function' ? (value as () => T)() : unref(value)
+}