@tanstack/solid-hotkeys 0.13.0 → 0.14.0

package/dist/createHotkeySequenceRecorder.js

@@ -1,43 +0,0 @@
-import { useDefaultHotkeysOptionsSource } from "./defaultOptions.js";
-import { HotkeySequenceRecorder } from "@tanstack/hotkeys";
-import { createEffect, onCleanup } from "solid-js";
-import { useSelector } from "@tanstack/solid-store";
-
-//#region src/createHotkeySequenceRecorder.ts
-/**
-* SolidJS primitive for recording multi-chord sequences (Vim-style shortcuts).
-*/
-function createHotkeySequenceRecorder(options) {
-	const defaultOptions = useDefaultHotkeysOptionsSource();
-	const resolvedOptions = typeof options === "function" ? options() : options;
-	const mergedOptions = {
-		...defaultOptions().hotkeySequenceRecorder,
-		...resolvedOptions
-	};
-	const recorder = new HotkeySequenceRecorder(mergedOptions);
-	const isRecording = useSelector(recorder.store, (state) => state.isRecording);
-	const steps = useSelector(recorder.store, (state) => state.steps);
-	const recordedSequence = useSelector(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 };

package/dist/createHotkeySequences.d.ts

@@ -1,54 +0,0 @@
-import { CreateHotkeySequenceOptions } from "./createHotkeySequence.js";
-import { HotkeyCallback, HotkeySequence } from "@tanstack/hotkeys";
-//#region src/createHotkeySequences.d.ts
-/**
- * A single sequence definition for use with `createHotkeySequences`.
- */
-export interface CreateHotkeySequenceDefinition {
-  /** Array of hotkey strings that form the sequence */
-  sequence: HotkeySequence;
-  /** The function to call when the sequence is completed */
-  callback: HotkeyCallback;
-  /** Per-sequence options (merged on top of commonOptions) */
-  options?: CreateHotkeySequenceOptions;
-}
-/**
- * SolidJS primitive for registering multiple keyboard shortcut sequences at once (Vim-style).
- *
- * Uses the singleton SequenceManager. Accepts a dynamic array of definitions, or accessors,
- * so you can react to variable-length lists.
- *
- * Options are merged in this order:
- * HotkeysProvider defaults < commonOptions < per-definition options
- *
- * Definitions with an empty `sequence` are skipped (no registration).
- *
- * @param sequences - Array of sequence definitions, or accessor returning them
- * @param commonOptions - Shared options for all sequences, or accessor
- *
- * @example
- * ```tsx
- * function VimPalette() {
- *   createHotkeySequences([
- *     { sequence: ['G', 'G'], callback: () => scrollToTop() },
- *     { sequence: ['D', 'D'], callback: () => deleteLine() },
- *   ])
- * }
- * ```
- *
- * @example
- * ```tsx
- * function Dynamic(props) {
- *   createHotkeySequences(
- *     () => props.items.map((item) => ({
- *       sequence: item.chords,
- *       callback: item.action,
- *       options: { enabled: item.enabled },
- *     })),
- *     { preventDefault: true },
- *   )
- * }
- * ```
- */
-export declare function createHotkeySequences(sequences: Array<CreateHotkeySequenceDefinition> | (() => Array<CreateHotkeySequenceDefinition>), commonOptions?: CreateHotkeySequenceOptions | (() => CreateHotkeySequenceOptions)): void;
-//#endregion

package/dist/createHotkeySequences.js

@@ -1,111 +0,0 @@
-import { useDefaultHotkeysOptionsSource } from "./defaultOptions.js";
-import { formatHotkeySequence, getSequenceManager } from "@tanstack/hotkeys";
-import { createEffect, onCleanup, untrack } from "solid-js";
-
-//#region src/createHotkeySequences.ts
-/**
-* SolidJS primitive for registering multiple keyboard shortcut sequences at once (Vim-style).
-*
-* Uses the singleton SequenceManager. Accepts a dynamic array of definitions, or accessors,
-* so you can react to variable-length lists.
-*
-* Options are merged in this order:
-* HotkeysProvider defaults < commonOptions < per-definition options
-*
-* Definitions with an empty `sequence` are skipped (no registration).
-*
-* @param sequences - Array of sequence definitions, or accessor returning them
-* @param commonOptions - Shared options for all sequences, or accessor
-*
-* @example
-* ```tsx
-* function VimPalette() {
-*   createHotkeySequences([
-*     { sequence: ['G', 'G'], callback: () => scrollToTop() },
-*     { sequence: ['D', 'D'], callback: () => deleteLine() },
-*   ])
-* }
-* ```
-*
-* @example
-* ```tsx
-* function Dynamic(props) {
-*   createHotkeySequences(
-*     () => props.items.map((item) => ({
-*       sequence: item.chords,
-*       callback: item.action,
-*       options: { enabled: item.enabled },
-*     })),
-*     { preventDefault: true },
-*   )
-* }
-* ```
-*/
-function createHotkeySequences(sequences, commonOptions = {}) {
-	const defaultOptions = useDefaultHotkeysOptionsSource();
-	const manager = getSequenceManager();
-	const registrations = /* @__PURE__ */ new Map();
-	onCleanup(() => {
-		for (const { handle } of registrations.values()) if (handle.isActive) handle.unregister();
-		registrations.clear();
-	});
-	createEffect(() => {
-		const resolved = typeof sequences === "function" ? sequences() : sequences;
-		const resolvedCommonOptions = typeof commonOptions === "function" ? commonOptions() : commonOptions;
-		const nextKeys = /* @__PURE__ */ new Set();
-		const prepared = [];
-		for (let i = 0; i < resolved.length; i++) {
-			const def = resolved[i];
-			const resolvedDefOptions = def.options ?? {};
-			const mergedOptions = {
-				...defaultOptions().hotkeySequence,
-				...resolvedCommonOptions,
-				...resolvedDefOptions
-			};
-			if (def.sequence.length === 0) continue;
-			const sequenceString = formatHotkeySequence(def.sequence);
-			const resolvedTarget = "target" in mergedOptions ? mergedOptions.target ?? null : typeof document !== "undefined" ? document : null;
-			if (!resolvedTarget) continue;
-			const registrationKey = `${i}:${sequenceString}`;
-			nextKeys.add(registrationKey);
-			prepared.push({
-				registrationKey,
-				def,
-				mergedOptions,
-				sequenceString,
-				resolvedTarget
-			});
-		}
-		untrack(() => {
-			for (const [key, record] of [...registrations.entries()]) if (!nextKeys.has(key)) {
-				if (record.handle.isActive) record.handle.unregister();
-				registrations.delete(key);
-			}
-			for (const p of prepared) {
-				const existing = registrations.get(p.registrationKey);
-				if (existing?.handle.isActive && existing.target === p.resolvedTarget) {
-					existing.handle.callback = p.def.callback;
-					const { target: _target, ...optionsWithoutTarget } = p.mergedOptions;
-					existing.handle.setOptions(optionsWithoutTarget);
-					continue;
-				}
-				if (existing) {
-					if (existing.handle.isActive) existing.handle.unregister();
-					registrations.delete(p.registrationKey);
-				}
-				const { target: _target, ...optionsWithoutTarget } = p.mergedOptions;
-				const handle = manager.register(p.def.sequence, p.def.callback, {
-					...optionsWithoutTarget,
-					target: p.resolvedTarget
-				});
-				registrations.set(p.registrationKey, {
-					handle,
-					target: p.resolvedTarget
-				});
-			}
-		});
-	});
-}
-
-//#endregion
-export { createHotkeySequences };