@tanstack/solid-hotkeys 0.5.1 → 0.6.0

package/dist/HotkeysProvider.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"HotkeysProvider.cjs","names":["createContext","useContext","JSX","ParentComponent","HotkeyRecorderOptions","CreateHotkeyOptions","CreateHotkeySequenceOptions","HotkeysProviderOptions","hotkey","Partial","hotkeyRecorder","hotkeySequence","HotkeysContextValue","defaultOptions","HotkeysContext","HotkeysProviderProps","children","Element","DEFAULT_OPTIONS","HotkeysProvider","props","contextValue","_$createComponent","Provider","value","useHotkeysContext","useDefaultHotkeysOptions","context"],"sources":["../src/HotkeysProvider.tsx"],"sourcesContent":["import { createContext, useContext } from 'solid-js'\nimport type { JSX, ParentComponent } from 'solid-js'\nimport type { HotkeyRecorderOptions } from '@tanstack/hotkeys'\nimport type { CreateHotkeyOptions } from './createHotkey'\nimport type { CreateHotkeySequenceOptions } from './createHotkeySequence'\n\nexport interface HotkeysProviderOptions {\n  hotkey?: Partial<CreateHotkeyOptions>\n  hotkeyRecorder?: Partial<HotkeyRecorderOptions>\n  hotkeySequence?: Partial<CreateHotkeySequenceOptions>\n}\n\ninterface HotkeysContextValue {\n  defaultOptions: HotkeysProviderOptions\n}\n\nconst HotkeysContext = createContext<HotkeysContextValue | null>(null)\n\nexport interface HotkeysProviderProps {\n  children: JSX.Element\n  defaultOptions?: HotkeysProviderOptions\n}\n\nconst DEFAULT_OPTIONS: HotkeysProviderOptions = {}\n\nexport const HotkeysProvider: ParentComponent<HotkeysProviderProps> = (\n  props,\n) => {\n  const contextValue: HotkeysContextValue = {\n    defaultOptions: props.defaultOptions ?? DEFAULT_OPTIONS,\n  }\n\n  return (\n    <HotkeysContext.Provider value={contextValue}>\n      {props.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":";;;;AAgBA,MAAMc,6CAA2D,KAAK;AAOtE,MAAMI,kBAA0C,EAAE;AAElD,MAAaC,mBACXC,UACG;CACH,MAAMC,eAAoC,EACxCR,gBAAgBO,MAAMP,kBAAkBK,iBACzC;AAED,0CACGJ,eAAeS,UAAQ;EAACC,OAAOH;EAAY,IAAAL,WAAA;AAAA,UACzCI,MAAMJ;;EAAQ,CAAA;;AAKrB,SAAgBS,oBAAoB;AAClC,iCAAkBX,eAAe;;AAGnC,SAAgBY,2BAA2B;AAEzC,iCAD2BZ,eAAe,EAC1BD,kBAAkB,EAAE"}
+{"version":3,"file":"HotkeysProvider.cjs","names":["createContext","useContext","JSX","ParentComponent","HotkeyRecorderOptions","HotkeySequenceRecorderOptions","CreateHotkeyOptions","CreateHotkeySequenceOptions","HotkeysProviderOptions","hotkey","Partial","hotkeyRecorder","hotkeySequenceRecorder","hotkeySequence","HotkeysContextValue","defaultOptions","HotkeysContext","HotkeysProviderProps","children","Element","DEFAULT_OPTIONS","HotkeysProvider","props","contextValue","_$createComponent","Provider","value","useHotkeysContext","useDefaultHotkeysOptions","context"],"sources":["../src/HotkeysProvider.tsx"],"sourcesContent":["import { createContext, useContext } from 'solid-js'\nimport type { JSX, ParentComponent } from 'solid-js'\nimport type {\n  HotkeyRecorderOptions,\n  HotkeySequenceRecorderOptions,\n} from '@tanstack/hotkeys'\nimport type { CreateHotkeyOptions } from './createHotkey'\nimport type { CreateHotkeySequenceOptions } from './createHotkeySequence'\n\nexport interface HotkeysProviderOptions {\n  hotkey?: Partial<CreateHotkeyOptions>\n  hotkeyRecorder?: Partial<HotkeyRecorderOptions>\n  hotkeySequenceRecorder?: Partial<HotkeySequenceRecorderOptions>\n  hotkeySequence?: Partial<CreateHotkeySequenceOptions>\n}\n\ninterface HotkeysContextValue {\n  defaultOptions: HotkeysProviderOptions\n}\n\nconst HotkeysContext = createContext<HotkeysContextValue | null>(null)\n\nexport interface HotkeysProviderProps {\n  children: JSX.Element\n  defaultOptions?: HotkeysProviderOptions\n}\n\nconst DEFAULT_OPTIONS: HotkeysProviderOptions = {}\n\nexport const HotkeysProvider: ParentComponent<HotkeysProviderProps> = (\n  props,\n) => {\n  const contextValue: HotkeysContextValue = {\n    defaultOptions: props.defaultOptions ?? DEFAULT_OPTIONS,\n  }\n\n  return (\n    <HotkeysContext.Provider value={contextValue}>\n      {props.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":";;;;AAoBA,MAAMgB,6CAA2D,KAAK;AAOtE,MAAMI,kBAA0C,EAAE;AAElD,MAAaC,mBACXC,UACG;CACH,MAAMC,eAAoC,EACxCR,gBAAgBO,MAAMP,kBAAkBK,iBACzC;AAED,0CACGJ,eAAeS,UAAQ;EAACC,OAAOH;EAAY,IAAAL,WAAA;AAAA,UACzCI,MAAMJ;;EAAQ,CAAA;;AAKrB,SAAgBS,oBAAoB;AAClC,iCAAkBX,eAAe;;AAGnC,SAAgBY,2BAA2B;AAEzC,iCAD2BZ,eAAe,EAC1BD,kBAAkB,EAAE"}

package/dist/HotkeysProvider.d.cts

@@ -1,12 +1,13 @@
 import { CreateHotkeyOptions } from "./createHotkey.cjs";
 import { CreateHotkeySequenceOptions } from "./createHotkeySequence.cjs";
-import { HotkeyRecorderOptions } from "@tanstack/hotkeys";
+import { HotkeyRecorderOptions, HotkeySequenceRecorderOptions } from "@tanstack/hotkeys";
 import { JSX, ParentComponent } from "solid-js";
 
 //#region src/HotkeysProvider.d.ts
 interface HotkeysProviderOptions {
   hotkey?: Partial<CreateHotkeyOptions>;
   hotkeyRecorder?: Partial<HotkeyRecorderOptions>;
+  hotkeySequenceRecorder?: Partial<HotkeySequenceRecorderOptions>;
   hotkeySequence?: Partial<CreateHotkeySequenceOptions>;
 }
 interface HotkeysContextValue {

package/dist/HotkeysProvider.d.ts

@@ -1,12 +1,13 @@
 import { CreateHotkeyOptions } from "./createHotkey.js";
 import { CreateHotkeySequenceOptions } from "./createHotkeySequence.js";
-import { HotkeyRecorderOptions } from "@tanstack/hotkeys";
+import { HotkeyRecorderOptions, HotkeySequenceRecorderOptions } from "@tanstack/hotkeys";
 import { JSX, ParentComponent } from "solid-js";
 
 //#region src/HotkeysProvider.d.ts
 interface HotkeysProviderOptions {
   hotkey?: Partial<CreateHotkeyOptions>;
   hotkeyRecorder?: Partial<HotkeyRecorderOptions>;
+  hotkeySequenceRecorder?: Partial<HotkeySequenceRecorderOptions>;
   hotkeySequence?: Partial<CreateHotkeySequenceOptions>;
 }
 interface HotkeysContextValue {

package/dist/HotkeysProvider.js.map

@@ -1 +1 @@
-{"version":3,"file":"HotkeysProvider.js","names":["createContext","useContext","JSX","ParentComponent","HotkeyRecorderOptions","CreateHotkeyOptions","CreateHotkeySequenceOptions","HotkeysProviderOptions","hotkey","Partial","hotkeyRecorder","hotkeySequence","HotkeysContextValue","defaultOptions","HotkeysContext","HotkeysProviderProps","children","Element","DEFAULT_OPTIONS","HotkeysProvider","props","contextValue","_$createComponent","Provider","value","useHotkeysContext","useDefaultHotkeysOptions","context"],"sources":["../src/HotkeysProvider.tsx"],"sourcesContent":["import { createContext, useContext } from 'solid-js'\nimport type { JSX, ParentComponent } from 'solid-js'\nimport type { HotkeyRecorderOptions } from '@tanstack/hotkeys'\nimport type { CreateHotkeyOptions } from './createHotkey'\nimport type { CreateHotkeySequenceOptions } from './createHotkeySequence'\n\nexport interface HotkeysProviderOptions {\n  hotkey?: Partial<CreateHotkeyOptions>\n  hotkeyRecorder?: Partial<HotkeyRecorderOptions>\n  hotkeySequence?: Partial<CreateHotkeySequenceOptions>\n}\n\ninterface HotkeysContextValue {\n  defaultOptions: HotkeysProviderOptions\n}\n\nconst HotkeysContext = createContext<HotkeysContextValue | null>(null)\n\nexport interface HotkeysProviderProps {\n  children: JSX.Element\n  defaultOptions?: HotkeysProviderOptions\n}\n\nconst DEFAULT_OPTIONS: HotkeysProviderOptions = {}\n\nexport const HotkeysProvider: ParentComponent<HotkeysProviderProps> = (\n  props,\n) => {\n  const contextValue: HotkeysContextValue = {\n    defaultOptions: props.defaultOptions ?? DEFAULT_OPTIONS,\n  }\n\n  return (\n    <HotkeysContext.Provider value={contextValue}>\n      {props.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":";;;;AAgBA,MAAMc,iBAAiBd,cAA0C,KAAK;AAOtE,MAAMkB,kBAA0C,EAAE;AAElD,MAAaC,mBACXC,UACG;CACH,MAAMC,eAAoC,EACxCR,gBAAgBO,MAAMP,kBAAkBK,iBACzC;AAED,QAAAI,gBACGR,eAAeS,UAAQ;EAACC,OAAOH;EAAY,IAAAL,WAAA;AAAA,UACzCI,MAAMJ;;EAAQ,CAAA;;AAKrB,SAAgBS,oBAAoB;AAClC,QAAOxB,WAAWa,eAAe;;AAGnC,SAAgBY,2BAA2B;AAEzC,QADgBzB,WAAWa,eAAe,EAC1BD,kBAAkB,EAAE"}
+{"version":3,"file":"HotkeysProvider.js","names":["createContext","useContext","JSX","ParentComponent","HotkeyRecorderOptions","HotkeySequenceRecorderOptions","CreateHotkeyOptions","CreateHotkeySequenceOptions","HotkeysProviderOptions","hotkey","Partial","hotkeyRecorder","hotkeySequenceRecorder","hotkeySequence","HotkeysContextValue","defaultOptions","HotkeysContext","HotkeysProviderProps","children","Element","DEFAULT_OPTIONS","HotkeysProvider","props","contextValue","_$createComponent","Provider","value","useHotkeysContext","useDefaultHotkeysOptions","context"],"sources":["../src/HotkeysProvider.tsx"],"sourcesContent":["import { createContext, useContext } from 'solid-js'\nimport type { JSX, ParentComponent } from 'solid-js'\nimport type {\n  HotkeyRecorderOptions,\n  HotkeySequenceRecorderOptions,\n} from '@tanstack/hotkeys'\nimport type { CreateHotkeyOptions } from './createHotkey'\nimport type { CreateHotkeySequenceOptions } from './createHotkeySequence'\n\nexport interface HotkeysProviderOptions {\n  hotkey?: Partial<CreateHotkeyOptions>\n  hotkeyRecorder?: Partial<HotkeyRecorderOptions>\n  hotkeySequenceRecorder?: Partial<HotkeySequenceRecorderOptions>\n  hotkeySequence?: Partial<CreateHotkeySequenceOptions>\n}\n\ninterface HotkeysContextValue {\n  defaultOptions: HotkeysProviderOptions\n}\n\nconst HotkeysContext = createContext<HotkeysContextValue | null>(null)\n\nexport interface HotkeysProviderProps {\n  children: JSX.Element\n  defaultOptions?: HotkeysProviderOptions\n}\n\nconst DEFAULT_OPTIONS: HotkeysProviderOptions = {}\n\nexport const HotkeysProvider: ParentComponent<HotkeysProviderProps> = (\n  props,\n) => {\n  const contextValue: HotkeysContextValue = {\n    defaultOptions: props.defaultOptions ?? DEFAULT_OPTIONS,\n  }\n\n  return (\n    <HotkeysContext.Provider value={contextValue}>\n      {props.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":";;;;AAoBA,MAAMgB,iBAAiBhB,cAA0C,KAAK;AAOtE,MAAMoB,kBAA0C,EAAE;AAElD,MAAaC,mBACXC,UACG;CACH,MAAMC,eAAoC,EACxCR,gBAAgBO,MAAMP,kBAAkBK,iBACzC;AAED,QAAAI,gBACGR,eAAeS,UAAQ;EAACC,OAAOH;EAAY,IAAAL,WAAA;AAAA,UACzCI,MAAMJ;;EAAQ,CAAA;;AAKrB,SAAgBS,oBAAoB;AAClC,QAAO1B,WAAWe,eAAe;;AAGnC,SAAgBY,2BAA2B;AAEzC,QADgB3B,WAAWe,eAAe,EAC1BD,kBAAkB,EAAE"}

package/dist/createHotkeySequenceRecorder.cjs

@@ -0,0 +1,43 @@
+const require_HotkeysProvider = require('./HotkeysProvider.cjs');
+let _tanstack_hotkeys = require("@tanstack/hotkeys");
+let solid_js = require("solid-js");
+let _tanstack_solid_store = require("@tanstack/solid-store");
+
+//#region src/createHotkeySequenceRecorder.ts
+/**
+* SolidJS primitive for recording multi-chord sequences (Vim-style shortcuts).
+*/
+function createHotkeySequenceRecorder(options) {
+	const defaultOptions = require_HotkeysProvider.useDefaultHotkeysOptions();
+	const resolvedOptions = typeof options === "function" ? options() : options;
+	const recorder = new _tanstack_hotkeys.HotkeySequenceRecorder({
+		...defaultOptions.hotkeySequenceRecorder,
+		...resolvedOptions
+	});
+	const isRecording = (0, _tanstack_solid_store.useStore)(recorder.store, (state) => state.isRecording);
+	const steps = (0, _tanstack_solid_store.useStore)(recorder.store, (state) => state.steps);
+	const recordedSequence = (0, _tanstack_solid_store.useStore)(recorder.store, (state) => state.recordedSequence);
+	(0, solid_js.createEffect)(() => {
+		const resolved = typeof options === "function" ? options() : options;
+		recorder.setOptions({
+			...defaultOptions.hotkeySequenceRecorder,
+			...resolved
+		});
+	});
+	(0, solid_js.onCleanup)(() => {
+		recorder.destroy();
+	});
+	return {
+		isRecording,
+		steps,
+		recordedSequence,
+		startRecording: () => recorder.start(),
+		stopRecording: () => recorder.stop(),
+		cancelRecording: () => recorder.cancel(),
+		commitRecording: () => recorder.commit()
+	};
+}
+
+//#endregion
+exports.createHotkeySequenceRecorder = createHotkeySequenceRecorder;
+//# sourceMappingURL=createHotkeySequenceRecorder.cjs.map

package/dist/createHotkeySequenceRecorder.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"createHotkeySequenceRecorder.cjs","names":["useDefaultHotkeysOptions","HotkeySequenceRecorder"],"sources":["../src/createHotkeySequenceRecorder.ts"],"sourcesContent":["import { createEffect, onCleanup } from 'solid-js'\nimport { useStore } from '@tanstack/solid-store'\nimport { HotkeySequenceRecorder } from '@tanstack/hotkeys'\nimport { useDefaultHotkeysOptions } from './HotkeysProvider'\nimport type {\n  HotkeySequence,\n  HotkeySequenceRecorderOptions,\n} from '@tanstack/hotkeys'\n\nexport interface SolidHotkeySequenceRecorder {\n  isRecording: () => boolean\n  steps: () => HotkeySequence\n  recordedSequence: () => HotkeySequence | null\n  startRecording: () => void\n  stopRecording: () => void\n  cancelRecording: () => void\n  commitRecording: () => void\n}\n\n/**\n * SolidJS primitive for recording multi-chord sequences (Vim-style shortcuts).\n */\nexport function createHotkeySequenceRecorder(\n  options:\n    | HotkeySequenceRecorderOptions\n    | (() => HotkeySequenceRecorderOptions),\n): SolidHotkeySequenceRecorder {\n  const defaultOptions = useDefaultHotkeysOptions()\n\n  const resolvedOptions = typeof options === 'function' ? options() : options\n  const mergedOptions = {\n    ...defaultOptions.hotkeySequenceRecorder,\n    ...resolvedOptions,\n  } as HotkeySequenceRecorderOptions\n\n  const recorder = new HotkeySequenceRecorder(mergedOptions)\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  createEffect(() => {\n    const resolved = typeof options === 'function' ? options() : options\n    recorder.setOptions({\n      ...defaultOptions.hotkeySequenceRecorder,\n      ...resolved,\n    } as HotkeySequenceRecorderOptions)\n  })\n\n  onCleanup(() => {\n    recorder.destroy()\n  })\n\n  return {\n    isRecording,\n    steps,\n    recordedSequence,\n    startRecording: () => recorder.start(),\n    stopRecording: () => recorder.stop(),\n    cancelRecording: () => recorder.cancel(),\n    commitRecording: () => recorder.commit(),\n  }\n}\n"],"mappings":";;;;;;;;;AAsBA,SAAgB,6BACd,SAG6B;CAC7B,MAAM,iBAAiBA,kDAA0B;CAEjD,MAAM,kBAAkB,OAAO,YAAY,aAAa,SAAS,GAAG;CAMpE,MAAM,WAAW,IAAIC,yCALC;EACpB,GAAG,eAAe;EAClB,GAAG;EACJ,CAEyD;CAE1D,MAAM,kDAAuB,SAAS,QAAQ,UAAU,MAAM,YAAY;CAC1E,MAAM,4CAAiB,SAAS,QAAQ,UAAU,MAAM,MAAM;CAC9D,MAAM,uDACJ,SAAS,QACR,UAAU,MAAM,iBAClB;AAED,kCAAmB;EACjB,MAAM,WAAW,OAAO,YAAY,aAAa,SAAS,GAAG;AAC7D,WAAS,WAAW;GAClB,GAAG,eAAe;GAClB,GAAG;GACJ,CAAkC;GACnC;AAEF,+BAAgB;AACd,WAAS,SAAS;GAClB;AAEF,QAAO;EACL;EACA;EACA;EACA,sBAAsB,SAAS,OAAO;EACtC,qBAAqB,SAAS,MAAM;EACpC,uBAAuB,SAAS,QAAQ;EACxC,uBAAuB,SAAS,QAAQ;EACzC"}

package/dist/createHotkeySequenceRecorder.d.cts

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

package/dist/createHotkeySequenceRecorder.d.ts

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

package/dist/createHotkeySequenceRecorder.js

@@ -0,0 +1,43 @@
+import { useDefaultHotkeysOptions } from "./HotkeysProvider.js";
+import { HotkeySequenceRecorder } from "@tanstack/hotkeys";
+import { createEffect, onCleanup } from "solid-js";
+import { useStore } from "@tanstack/solid-store";
+
+//#region src/createHotkeySequenceRecorder.ts
+/**
+* SolidJS primitive for recording multi-chord sequences (Vim-style shortcuts).
+*/
+function createHotkeySequenceRecorder(options) {
+	const defaultOptions = useDefaultHotkeysOptions();
+	const resolvedOptions = typeof options === "function" ? options() : options;
+	const recorder = new HotkeySequenceRecorder({
+		...defaultOptions.hotkeySequenceRecorder,
+		...resolvedOptions
+	});
+	const isRecording = useStore(recorder.store, (state) => state.isRecording);
+	const steps = useStore(recorder.store, (state) => state.steps);
+	const recordedSequence = useStore(recorder.store, (state) => state.recordedSequence);
+	createEffect(() => {
+		const resolved = typeof options === "function" ? options() : options;
+		recorder.setOptions({
+			...defaultOptions.hotkeySequenceRecorder,
+			...resolved
+		});
+	});
+	onCleanup(() => {
+		recorder.destroy();
+	});
+	return {
+		isRecording,
+		steps,
+		recordedSequence,
+		startRecording: () => recorder.start(),
+		stopRecording: () => recorder.stop(),
+		cancelRecording: () => recorder.cancel(),
+		commitRecording: () => recorder.commit()
+	};
+}
+
+//#endregion
+export { createHotkeySequenceRecorder };
+//# sourceMappingURL=createHotkeySequenceRecorder.js.map

package/dist/createHotkeySequenceRecorder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createHotkeySequenceRecorder.js","names":[],"sources":["../src/createHotkeySequenceRecorder.ts"],"sourcesContent":["import { createEffect, onCleanup } from 'solid-js'\nimport { useStore } from '@tanstack/solid-store'\nimport { HotkeySequenceRecorder } from '@tanstack/hotkeys'\nimport { useDefaultHotkeysOptions } from './HotkeysProvider'\nimport type {\n  HotkeySequence,\n  HotkeySequenceRecorderOptions,\n} from '@tanstack/hotkeys'\n\nexport interface SolidHotkeySequenceRecorder {\n  isRecording: () => boolean\n  steps: () => HotkeySequence\n  recordedSequence: () => HotkeySequence | null\n  startRecording: () => void\n  stopRecording: () => void\n  cancelRecording: () => void\n  commitRecording: () => void\n}\n\n/**\n * SolidJS primitive for recording multi-chord sequences (Vim-style shortcuts).\n */\nexport function createHotkeySequenceRecorder(\n  options:\n    | HotkeySequenceRecorderOptions\n    | (() => HotkeySequenceRecorderOptions),\n): SolidHotkeySequenceRecorder {\n  const defaultOptions = useDefaultHotkeysOptions()\n\n  const resolvedOptions = typeof options === 'function' ? options() : options\n  const mergedOptions = {\n    ...defaultOptions.hotkeySequenceRecorder,\n    ...resolvedOptions,\n  } as HotkeySequenceRecorderOptions\n\n  const recorder = new HotkeySequenceRecorder(mergedOptions)\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  createEffect(() => {\n    const resolved = typeof options === 'function' ? options() : options\n    recorder.setOptions({\n      ...defaultOptions.hotkeySequenceRecorder,\n      ...resolved,\n    } as HotkeySequenceRecorderOptions)\n  })\n\n  onCleanup(() => {\n    recorder.destroy()\n  })\n\n  return {\n    isRecording,\n    steps,\n    recordedSequence,\n    startRecording: () => recorder.start(),\n    stopRecording: () => recorder.stop(),\n    cancelRecording: () => recorder.cancel(),\n    commitRecording: () => recorder.commit(),\n  }\n}\n"],"mappings":";;;;;;;;;AAsBA,SAAgB,6BACd,SAG6B;CAC7B,MAAM,iBAAiB,0BAA0B;CAEjD,MAAM,kBAAkB,OAAO,YAAY,aAAa,SAAS,GAAG;CAMpE,MAAM,WAAW,IAAI,uBALC;EACpB,GAAG,eAAe;EAClB,GAAG;EACJ,CAEyD;CAE1D,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;AAED,oBAAmB;EACjB,MAAM,WAAW,OAAO,YAAY,aAAa,SAAS,GAAG;AAC7D,WAAS,WAAW;GAClB,GAAG,eAAe;GAClB,GAAG;GACJ,CAAkC;GACnC;AAEF,iBAAgB;AACd,WAAS,SAAS;GAClB;AAEF,QAAO;EACL;EACA;EACA;EACA,sBAAsB,SAAS,OAAO;EACtC,qBAAqB,SAAS,MAAM;EACpC,uBAAuB,SAAS,QAAQ;EACxC,uBAAuB,SAAS,QAAQ;EACzC"}

package/dist/index.cjs

@@ -7,6 +7,7 @@ const require_createHeldKeyCodes = require('./createHeldKeyCodes.cjs');
 const require_createKeyHold = require('./createKeyHold.cjs');
 const require_createHotkeySequence = require('./createHotkeySequence.cjs');
 const require_createHotkeyRecorder = require('./createHotkeyRecorder.cjs');
+const require_createHotkeySequenceRecorder = require('./createHotkeySequenceRecorder.cjs');
 
 exports.HotkeysProvider = require_HotkeysProvider.HotkeysProvider;
 exports.createHeldKeyCodes = require_createHeldKeyCodes.createHeldKeyCodes;
@@ -14,6 +15,7 @@ exports.createHeldKeys = require_createHeldKeys.createHeldKeys;
 exports.createHotkey = require_createHotkey.createHotkey;
 exports.createHotkeyRecorder = require_createHotkeyRecorder.createHotkeyRecorder;
 exports.createHotkeySequence = require_createHotkeySequence.createHotkeySequence;
+exports.createHotkeySequenceRecorder = require_createHotkeySequenceRecorder.createHotkeySequenceRecorder;
 exports.createHotkeys = require_createHotkeys.createHotkeys;
 exports.createKeyHold = require_createKeyHold.createKeyHold;
 exports.useDefaultHotkeysOptions = require_HotkeysProvider.useDefaultHotkeysOptions;

package/dist/index.d.cts

@@ -6,5 +6,6 @@ import { createHeldKeys } from "./createHeldKeys.cjs";
 import { createHeldKeyCodes } from "./createHeldKeyCodes.cjs";
 import { createKeyHold } from "./createKeyHold.cjs";
 import { SolidHotkeyRecorder, createHotkeyRecorder } from "./createHotkeyRecorder.cjs";
+import { SolidHotkeySequenceRecorder, createHotkeySequenceRecorder } from "./createHotkeySequenceRecorder.cjs";
 export * from "@tanstack/hotkeys";
-export { CreateHotkeyDefinition, CreateHotkeyOptions, CreateHotkeySequenceOptions, HotkeysProvider, HotkeysProviderOptions, HotkeysProviderProps, SolidHotkeyRecorder, createHeldKeyCodes, createHeldKeys, createHotkey, createHotkeyRecorder, createHotkeySequence, createHotkeys, createKeyHold, useDefaultHotkeysOptions, useHotkeysContext };
+export { CreateHotkeyDefinition, CreateHotkeyOptions, CreateHotkeySequenceOptions, HotkeysProvider, HotkeysProviderOptions, HotkeysProviderProps, SolidHotkeyRecorder, SolidHotkeySequenceRecorder, createHeldKeyCodes, createHeldKeys, createHotkey, createHotkeyRecorder, createHotkeySequence, createHotkeySequenceRecorder, createHotkeys, createKeyHold, useDefaultHotkeysOptions, useHotkeysContext };

package/dist/index.d.ts

@@ -6,5 +6,6 @@ import { createHeldKeys } from "./createHeldKeys.js";
 import { createHeldKeyCodes } from "./createHeldKeyCodes.js";
 import { createKeyHold } from "./createKeyHold.js";
 import { SolidHotkeyRecorder, createHotkeyRecorder } from "./createHotkeyRecorder.js";
+import { SolidHotkeySequenceRecorder, createHotkeySequenceRecorder } from "./createHotkeySequenceRecorder.js";
 export * from "@tanstack/hotkeys";
-export { CreateHotkeyDefinition, CreateHotkeyOptions, CreateHotkeySequenceOptions, HotkeysProvider, HotkeysProviderOptions, HotkeysProviderProps, SolidHotkeyRecorder, createHeldKeyCodes, createHeldKeys, createHotkey, createHotkeyRecorder, createHotkeySequence, createHotkeys, createKeyHold, useDefaultHotkeysOptions, useHotkeysContext };
+export { CreateHotkeyDefinition, CreateHotkeyOptions, CreateHotkeySequenceOptions, HotkeysProvider, HotkeysProviderOptions, HotkeysProviderProps, SolidHotkeyRecorder, SolidHotkeySequenceRecorder, createHeldKeyCodes, createHeldKeys, createHotkey, createHotkeyRecorder, createHotkeySequence, createHotkeySequenceRecorder, createHotkeys, createKeyHold, useDefaultHotkeysOptions, useHotkeysContext };

package/dist/index.js

@@ -6,7 +6,8 @@ import { createHeldKeyCodes } from "./createHeldKeyCodes.js";
 import { createKeyHold } from "./createKeyHold.js";
 import { createHotkeySequence } from "./createHotkeySequence.js";
 import { createHotkeyRecorder } from "./createHotkeyRecorder.js";
+import { createHotkeySequenceRecorder } from "./createHotkeySequenceRecorder.js";
 
 export * from "@tanstack/hotkeys"
 
-export { HotkeysProvider, createHeldKeyCodes, createHeldKeys, createHotkey, createHotkeyRecorder, createHotkeySequence, createHotkeys, createKeyHold, useDefaultHotkeysOptions, useHotkeysContext };
+export { HotkeysProvider, createHeldKeyCodes, createHeldKeys, createHotkey, createHotkeyRecorder, createHotkeySequence, createHotkeySequenceRecorder, createHotkeys, createKeyHold, useDefaultHotkeysOptions, useHotkeysContext };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/solid-hotkeys",
-  "version": "0.5.1",
+  "version": "0.6.0",
   "description": "SolidJS adapter for TanStack Hotkeys",
   "author": "Tanner Linsley",
   "license": "MIT",
@@ -43,7 +43,7 @@
   ],
   "dependencies": {
     "@tanstack/solid-store": "^0.9.2",
-    "@tanstack/hotkeys": "0.4.3"
+    "@tanstack/hotkeys": "0.5.0"
   },
   "devDependencies": {
     "@solidjs/testing-library": "^0.8.10",

package/src/HotkeysProvider.tsx

@@ -1,12 +1,16 @@
 import { createContext, useContext } from 'solid-js'
 import type { JSX, ParentComponent } from 'solid-js'
-import type { HotkeyRecorderOptions } from '@tanstack/hotkeys'
+import type {
+  HotkeyRecorderOptions,
+  HotkeySequenceRecorderOptions,
+} from '@tanstack/hotkeys'
 import type { CreateHotkeyOptions } from './createHotkey'
 import type { CreateHotkeySequenceOptions } from './createHotkeySequence'
 
 export interface HotkeysProviderOptions {
   hotkey?: Partial<CreateHotkeyOptions>
   hotkeyRecorder?: Partial<HotkeyRecorderOptions>
+  hotkeySequenceRecorder?: Partial<HotkeySequenceRecorderOptions>
   hotkeySequence?: Partial<CreateHotkeySequenceOptions>
 }
 

package/src/createHotkeySequenceRecorder.ts

@@ -0,0 +1,66 @@
+import { createEffect, onCleanup } from 'solid-js'
+import { useStore } from '@tanstack/solid-store'
+import { HotkeySequenceRecorder } from '@tanstack/hotkeys'
+import { useDefaultHotkeysOptions } from './HotkeysProvider'
+import type {
+  HotkeySequence,
+  HotkeySequenceRecorderOptions,
+} from '@tanstack/hotkeys'
+
+export interface SolidHotkeySequenceRecorder {
+  isRecording: () => boolean
+  steps: () => HotkeySequence
+  recordedSequence: () => HotkeySequence | null
+  startRecording: () => void
+  stopRecording: () => void
+  cancelRecording: () => void
+  commitRecording: () => void
+}
+
+/**
+ * SolidJS primitive for recording multi-chord sequences (Vim-style shortcuts).
+ */
+export function createHotkeySequenceRecorder(
+  options:
+    | HotkeySequenceRecorderOptions
+    | (() => HotkeySequenceRecorderOptions),
+): SolidHotkeySequenceRecorder {
+  const defaultOptions = useDefaultHotkeysOptions()
+
+  const resolvedOptions = typeof options === 'function' ? options() : options
+  const mergedOptions = {
+    ...defaultOptions.hotkeySequenceRecorder,
+    ...resolvedOptions,
+  } as HotkeySequenceRecorderOptions
+
+  const recorder = new HotkeySequenceRecorder(mergedOptions)
+
+  const isRecording = useStore(recorder.store, (state) => state.isRecording)
+  const steps = useStore(recorder.store, (state) => state.steps)
+  const recordedSequence = useStore(
+    recorder.store,
+    (state) => state.recordedSequence,
+  )
+
+  createEffect(() => {
+    const resolved = typeof options === 'function' ? options() : options
+    recorder.setOptions({
+      ...defaultOptions.hotkeySequenceRecorder,
+      ...resolved,
+    } as HotkeySequenceRecorderOptions)
+  })
+
+  onCleanup(() => {
+    recorder.destroy()
+  })
+
+  return {
+    isRecording,
+    steps,
+    recordedSequence,
+    startRecording: () => recorder.start(),
+    stopRecording: () => recorder.stop(),
+    cancelRecording: () => recorder.cancel(),
+    commitRecording: () => recorder.commit(),
+  }
+}

package/src/index.ts

@@ -12,3 +12,4 @@ export * from './createHeldKeyCodes'
 export * from './createKeyHold'
 export * from './createHotkeySequence'
 export * from './createHotkeyRecorder'
+export * from './createHotkeySequenceRecorder'