@tanstack/svelte-hotkeys 0.5.0 → 0.6.0

package/dist/HotkeysCtx.d.ts

@@ -1,10 +1,11 @@
-import type { HotkeyRecorderOptions } from '@tanstack/hotkeys';
+import type { HotkeyRecorderOptions, HotkeySequenceRecorderOptions } from '@tanstack/hotkeys';
 import type { CreateHotkeyOptions } from './createHotkey.svelte';
 import type { Snippet } from 'svelte';
 import type { CreateHotkeySequenceOptions } from './createHotkeySequence.svelte';
 export interface HotkeysProviderOptions {
     hotkey?: Partial<CreateHotkeyOptions>;
     hotkeyRecorder?: Partial<HotkeyRecorderOptions>;
+    hotkeySequenceRecorder?: Partial<HotkeySequenceRecorderOptions>;
     hotkeySequence?: Partial<CreateHotkeySequenceOptions>;
 }
 export interface HotkeysProviderProps {

package/dist/createHotkeySequence.svelte.d.ts

@@ -7,6 +7,11 @@ export interface CreateHotkeySequenceOptions extends Omit<SequenceOptions, 'targ
 /**
  * Register a global keyboard shortcut sequence for the current component.
  *
+ * Each step may include modifiers. You can chain the same modifier across
+ * steps (e.g. `Shift+R` then `Shift+T`). Modifier-only keydown events (Shift,
+ * Control, Alt, or Meta pressed alone) are ignored while matching—they do not
+ * advance the sequence or reset progress.
+ *
  * @example
  * ```svelte
  * <script lang="ts">
@@ -26,6 +31,11 @@ export interface CreateHotkeySequenceOptions extends Omit<SequenceOptions, 'targ
  *   createHotkeySequence(['D', 'I', 'W'], () => {
  *     deleteInnerWord()
  *   }, { timeout: 500 })
+ *
+ *   // Same modifier on consecutive steps (bare Shift between chords is ignored)
+ *   createHotkeySequence(['Shift+R', 'Shift+T'], () => {
+ *     nextAction()
+ *   })
  * </script>
  *
  * <div>

package/dist/createHotkeySequence.svelte.js

@@ -16,6 +16,11 @@ function registerHotkeySequence(target, sequence, callback, options) {
 /**
  * Register a global keyboard shortcut sequence for the current component.
  *
+ * Each step may include modifiers. You can chain the same modifier across
+ * steps (e.g. `Shift+R` then `Shift+T`). Modifier-only keydown events (Shift,
+ * Control, Alt, or Meta pressed alone) are ignored while matching—they do not
+ * advance the sequence or reset progress.
+ *
  * @example
  * ```svelte
  * <script lang="ts">
@@ -35,6 +40,11 @@ function registerHotkeySequence(target, sequence, callback, options) {
  *   createHotkeySequence(['D', 'I', 'W'], () => {
  *     deleteInnerWord()
  *   }, { timeout: 500 })
+ *
+ *   // Same modifier on consecutive steps (bare Shift between chords is ignored)
+ *   createHotkeySequence(['Shift+R', 'Shift+T'], () => {
+ *     nextAction()
+ *   })
  * </script>
  *
  * <div>

package/dist/createHotkeySequenceRecorder.svelte.d.ts

@@ -0,0 +1,15 @@
+import type { HotkeySequence, HotkeySequenceRecorderOptions } from '@tanstack/hotkeys';
+import type { MaybeGetter } from './internal.svelte';
+export interface SvelteHotkeySequenceRecorder {
+    readonly isRecording: boolean;
+    readonly steps: HotkeySequence;
+    readonly recordedSequence: HotkeySequence | null;
+    startRecording: () => void;
+    stopRecording: () => void;
+    cancelRecording: () => void;
+    commitRecording: () => void;
+}
+/**
+ * Svelte helper for recording multi-chord sequences (Vim-style shortcuts).
+ */
+export declare function createHotkeySequenceRecorder(options: MaybeGetter<HotkeySequenceRecorderOptions>): SvelteHotkeySequenceRecorder;

package/dist/createHotkeySequenceRecorder.svelte.js

@@ -0,0 +1,74 @@
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _SvelteHotkeySequenceRecorderState_recorder, _SvelteHotkeySequenceRecorderState_subscribe;
+import { HotkeySequenceRecorder } from '@tanstack/hotkeys';
+import { onDestroy } from 'svelte';
+import { getDefaultHotkeysOptions } from './HotkeysCtx';
+import { createStoreSubscriber, resolveMaybeGetter } from './internal.svelte';
+class SvelteHotkeySequenceRecorderState {
+    constructor(options) {
+        _SvelteHotkeySequenceRecorderState_recorder.set(this, void 0);
+        _SvelteHotkeySequenceRecorderState_subscribe.set(this, void 0);
+        __classPrivateFieldSet(this, _SvelteHotkeySequenceRecorderState_recorder, new HotkeySequenceRecorder(options), "f");
+        __classPrivateFieldSet(this, _SvelteHotkeySequenceRecorderState_subscribe, createStoreSubscriber(__classPrivateFieldGet(this, _SvelteHotkeySequenceRecorderState_recorder, "f").store), "f");
+    }
+    get isRecording() {
+        __classPrivateFieldGet(this, _SvelteHotkeySequenceRecorderState_subscribe, "f").call(this);
+        return __classPrivateFieldGet(this, _SvelteHotkeySequenceRecorderState_recorder, "f").store.state.isRecording;
+    }
+    get steps() {
+        __classPrivateFieldGet(this, _SvelteHotkeySequenceRecorderState_subscribe, "f").call(this);
+        return __classPrivateFieldGet(this, _SvelteHotkeySequenceRecorderState_recorder, "f").store.state.steps;
+    }
+    get recordedSequence() {
+        __classPrivateFieldGet(this, _SvelteHotkeySequenceRecorderState_subscribe, "f").call(this);
+        return __classPrivateFieldGet(this, _SvelteHotkeySequenceRecorderState_recorder, "f").store.state.recordedSequence;
+    }
+    setOptions(options) {
+        __classPrivateFieldGet(this, _SvelteHotkeySequenceRecorderState_recorder, "f").setOptions(options);
+    }
+    startRecording() {
+        __classPrivateFieldGet(this, _SvelteHotkeySequenceRecorderState_recorder, "f").start();
+    }
+    stopRecording() {
+        __classPrivateFieldGet(this, _SvelteHotkeySequenceRecorderState_recorder, "f").stop();
+    }
+    cancelRecording() {
+        __classPrivateFieldGet(this, _SvelteHotkeySequenceRecorderState_recorder, "f").cancel();
+    }
+    commitRecording() {
+        __classPrivateFieldGet(this, _SvelteHotkeySequenceRecorderState_recorder, "f").commit();
+    }
+    destroy() {
+        __classPrivateFieldGet(this, _SvelteHotkeySequenceRecorderState_recorder, "f").destroy();
+    }
+}
+_SvelteHotkeySequenceRecorderState_recorder = new WeakMap(), _SvelteHotkeySequenceRecorderState_subscribe = new WeakMap();
+/**
+ * Svelte helper for recording multi-chord sequences (Vim-style shortcuts).
+ */
+export function createHotkeySequenceRecorder(options) {
+    const recorder = new SvelteHotkeySequenceRecorderState({
+        ...getDefaultHotkeysOptions().hotkeySequenceRecorder,
+        ...resolveMaybeGetter(options),
+    });
+    $effect(() => {
+        recorder.setOptions({
+            ...getDefaultHotkeysOptions().hotkeySequenceRecorder,
+            ...resolveMaybeGetter(options),
+        });
+    });
+    onDestroy(() => {
+        recorder.destroy();
+    });
+    return recorder;
+}

package/dist/index.d.ts

@@ -3,6 +3,7 @@ export * from './createHotkey.svelte';
 export * from './createHotkeys.svelte';
 export * from './createHotkeySequence.svelte';
 export * from './createHotkeyRecorder.svelte';
+export * from './createHotkeySequenceRecorder.svelte';
 export * from './getHeldKeys.svelte';
 export * from './getHeldKeyCodesMap.svelte';
 export * from './getIsKeyHeld.svelte';

package/dist/index.js

@@ -4,6 +4,7 @@ export * from './createHotkey.svelte';
 export * from './createHotkeys.svelte';
 export * from './createHotkeySequence.svelte';
 export * from './createHotkeyRecorder.svelte';
+export * from './createHotkeySequenceRecorder.svelte';
 export * from './getHeldKeys.svelte';
 export * from './getHeldKeyCodesMap.svelte';
 export * from './getIsKeyHeld.svelte';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/svelte-hotkeys",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "Svelte adapter for TanStack Hotkeys",
   "author": "Kunal Rao",
   "license": "MIT",
@@ -40,7 +40,7 @@
     "src"
   ],
   "dependencies": {
-    "@tanstack/hotkeys": "0.4.2"
+    "@tanstack/hotkeys": "0.5.0"
   },
   "devDependencies": {
     "@sveltejs/package": "^2.5.7",

package/src/HotkeysCtx.ts

@@ -1,5 +1,8 @@
 import { createContext } from 'svelte'
-import type { HotkeyRecorderOptions } from '@tanstack/hotkeys'
+import type {
+  HotkeyRecorderOptions,
+  HotkeySequenceRecorderOptions,
+} from '@tanstack/hotkeys'
 import type { CreateHotkeyOptions } from './createHotkey.svelte'
 import type { Snippet } from 'svelte'
 import type { CreateHotkeySequenceOptions } from './createHotkeySequence.svelte'
@@ -7,6 +10,7 @@ import type { CreateHotkeySequenceOptions } from './createHotkeySequence.svelte'
 export interface HotkeysProviderOptions {
   hotkey?: Partial<CreateHotkeyOptions>
   hotkeyRecorder?: Partial<HotkeyRecorderOptions>
+  hotkeySequenceRecorder?: Partial<HotkeySequenceRecorderOptions>
   hotkeySequence?: Partial<CreateHotkeySequenceOptions>
 }
 

package/src/createHotkeySequence.svelte.ts

@@ -38,6 +38,11 @@ function registerHotkeySequence(
 /**
  * Register a global keyboard shortcut sequence for the current component.
  *
+ * Each step may include modifiers. You can chain the same modifier across
+ * steps (e.g. `Shift+R` then `Shift+T`). Modifier-only keydown events (Shift,
+ * Control, Alt, or Meta pressed alone) are ignored while matching—they do not
+ * advance the sequence or reset progress.
+ *
  * @example
  * ```svelte
  * <script lang="ts">
@@ -57,6 +62,11 @@ function registerHotkeySequence(
  *   createHotkeySequence(['D', 'I', 'W'], () => {
  *     deleteInnerWord()
  *   }, { timeout: 500 })
+ *
+ *   // Same modifier on consecutive steps (bare Shift between chords is ignored)
+ *   createHotkeySequence(['Shift+R', 'Shift+T'], () => {
+ *     nextAction()
+ *   })
  * </script>
  *
  * <div>

package/src/createHotkeySequenceRecorder.svelte.ts

@@ -0,0 +1,93 @@
+import { HotkeySequenceRecorder } from '@tanstack/hotkeys'
+import { onDestroy } from 'svelte'
+import { getDefaultHotkeysOptions } from './HotkeysCtx'
+import { createStoreSubscriber, resolveMaybeGetter } from './internal.svelte'
+import type {
+  HotkeySequence,
+  HotkeySequenceRecorderOptions,
+} from '@tanstack/hotkeys'
+import type { MaybeGetter } from './internal.svelte'
+
+export interface SvelteHotkeySequenceRecorder {
+  readonly isRecording: boolean
+  readonly steps: HotkeySequence
+  readonly recordedSequence: HotkeySequence | null
+  startRecording: () => void
+  stopRecording: () => void
+  cancelRecording: () => void
+  commitRecording: () => void
+}
+
+class SvelteHotkeySequenceRecorderState implements SvelteHotkeySequenceRecorder {
+  #recorder: HotkeySequenceRecorder
+  #subscribe: () => void
+
+  constructor(options: HotkeySequenceRecorderOptions) {
+    this.#recorder = new HotkeySequenceRecorder(options)
+    this.#subscribe = createStoreSubscriber(this.#recorder.store)
+  }
+
+  get isRecording(): boolean {
+    this.#subscribe()
+    return this.#recorder.store.state.isRecording
+  }
+
+  get steps(): HotkeySequence {
+    this.#subscribe()
+    return this.#recorder.store.state.steps
+  }
+
+  get recordedSequence(): HotkeySequence | null {
+    this.#subscribe()
+    return this.#recorder.store.state.recordedSequence
+  }
+
+  setOptions(options: HotkeySequenceRecorderOptions): void {
+    this.#recorder.setOptions(options)
+  }
+
+  startRecording(): void {
+    this.#recorder.start()
+  }
+
+  stopRecording(): void {
+    this.#recorder.stop()
+  }
+
+  cancelRecording(): void {
+    this.#recorder.cancel()
+  }
+
+  commitRecording(): void {
+    this.#recorder.commit()
+  }
+
+  destroy(): void {
+    this.#recorder.destroy()
+  }
+}
+
+/**
+ * Svelte helper for recording multi-chord sequences (Vim-style shortcuts).
+ */
+export function createHotkeySequenceRecorder(
+  options: MaybeGetter<HotkeySequenceRecorderOptions>,
+): SvelteHotkeySequenceRecorder {
+  const recorder = new SvelteHotkeySequenceRecorderState({
+    ...getDefaultHotkeysOptions().hotkeySequenceRecorder,
+    ...resolveMaybeGetter(options),
+  } as HotkeySequenceRecorderOptions)
+
+  $effect(() => {
+    recorder.setOptions({
+      ...getDefaultHotkeysOptions().hotkeySequenceRecorder,
+      ...resolveMaybeGetter(options),
+    } as HotkeySequenceRecorderOptions)
+  })
+
+  onDestroy(() => {
+    recorder.destroy()
+  })
+
+  return recorder
+}

package/src/index.ts

@@ -5,6 +5,7 @@ export * from './createHotkey.svelte'
 export * from './createHotkeys.svelte'
 export * from './createHotkeySequence.svelte'
 export * from './createHotkeyRecorder.svelte'
+export * from './createHotkeySequenceRecorder.svelte'
 export * from './getHeldKeys.svelte'
 export * from './getHeldKeyCodesMap.svelte'
 export * from './getIsKeyHeld.svelte'