@tanstack/svelte-hotkeys 0.7.0 → 0.8.0

package/README.md

@@ -37,7 +37,7 @@
 # TanStack Hotkeys
 
 > [!NOTE]
-> TanStack Hotkeys is pre-alpha (prototyping phase). We are actively developing the library and are open to feedback and contributions.
+> TanStack Hotkeys is alpha. We are actively developing the library and are open to feedback and contributions.
 
 Type-safe keyboard shortcuts for the web. Template-string bindings, parsed objects, a cross-platform `Mod` key, a singleton Hotkey Manager, and utilities for cheatsheet UIs—built to stay SSR-friendly.
 

package/dist/createHotkey.svelte.js

@@ -1,15 +1,9 @@
-import { detectPlatform, formatHotkey, getHotkeyManager, rawHotkeyToParsedHotkey, } from '@tanstack/hotkeys';
+import { detectPlatform, getHotkeyManager, normalizeRegisterableHotkey, } from '@tanstack/hotkeys';
 import { onDestroy } from 'svelte';
 import { getDefaultHotkeysOptions } from './HotkeysCtx';
 import { resolveMaybeGetter } from './internal.svelte';
-function normalizeHotkey(hotkey, options) {
-    const platform = options.platform ?? detectPlatform();
-    return typeof hotkey === 'string'
-        ? hotkey
-        : formatHotkey(rawHotkeyToParsedHotkey(hotkey, platform));
-}
 function registerHotkey(target, hotkey, callback, mergedOptions) {
-    return getHotkeyManager().register(normalizeHotkey(hotkey, mergedOptions), callback, {
+    return getHotkeyManager().register(normalizeRegisterableHotkey(hotkey, mergedOptions.platform ?? detectPlatform()), callback, {
         ...mergedOptions,
         target,
     });
@@ -41,7 +35,7 @@ export function createHotkey(hotkey, callback, options = {}) {
             ...getDefaultHotkeysOptions().hotkey,
             ...resolvedOptions,
         };
-        const hotkeyStr = normalizeHotkey(resolvedHotkey, mergedOptions);
+        const hotkeyStr = normalizeRegisterableHotkey(resolvedHotkey, mergedOptions.platform ?? detectPlatform());
         const { target: _t, ...optionsWithoutTarget } = mergedOptions;
         if (registration?.isActive && lastHotkeyStr === hotkeyStr) {
             registration.callback = callback;
@@ -93,7 +87,7 @@ export function createHotkeyAttachment(hotkey, callback, options = {}) {
                 ...getDefaultHotkeysOptions().hotkey,
                 ...resolvedOptions,
             };
-            const hotkeyStr = normalizeHotkey(resolvedHotkey, mergedOptions);
+            const hotkeyStr = normalizeRegisterableHotkey(resolvedHotkey, mergedOptions.platform ?? detectPlatform());
             const { target: _t, ...optionsWithoutTarget } = mergedOptions;
             if (registration?.isActive && lastHotkeyStr === hotkeyStr) {
                 registration.callback = callback;

package/dist/createHotkeys.svelte.js

@@ -1,14 +1,8 @@
-import { detectPlatform, formatHotkey, getHotkeyManager, rawHotkeyToParsedHotkey, } from '@tanstack/hotkeys';
+import { detectPlatform, getHotkeyManager, normalizeRegisterableHotkey, } from '@tanstack/hotkeys';
 import { onDestroy } from 'svelte';
 import { SvelteMap, SvelteSet } from 'svelte/reactivity';
 import { getDefaultHotkeysOptions } from './HotkeysCtx';
 import { resolveMaybeGetter } from './internal.svelte';
-function normalizeHotkey(hotkey, options) {
-    const platform = options.platform ?? detectPlatform();
-    return typeof hotkey === 'string'
-        ? hotkey
-        : formatHotkey(rawHotkeyToParsedHotkey(hotkey, platform));
-}
 function cleanupRegistrations(registrations) {
     for (const { handle } of registrations.values()) {
         if (handle.isActive) {
@@ -62,7 +56,7 @@ export function createHotkeys(hotkeys, commonOptions = {}) {
             if (!resolvedTarget) {
                 continue;
             }
-            const hotkeyString = normalizeHotkey(resolvedHotkey, mergedOptions);
+            const hotkeyString = normalizeRegisterableHotkey(resolvedHotkey, mergedOptions.platform ?? detectPlatform());
             const registrationKey = `${i}:${hotkeyString}`;
             nextKeys.add(registrationKey);
             prepared.push({
@@ -144,7 +138,7 @@ export function createHotkeysAttachment(hotkeys, commonOptions = {}) {
                     ...resolvedCommonOptions,
                     ...resolvedDefOptions,
                 };
-                const hotkeyString = normalizeHotkey(resolvedHotkey, mergedOptions);
+                const hotkeyString = normalizeRegisterableHotkey(resolvedHotkey, mergedOptions.platform ?? detectPlatform());
                 const registrationKey = `${i}:${hotkeyString}`;
                 nextKeys.add(registrationKey);
                 prepared.push({

package/package.json

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

package/src/createHotkey.svelte.ts

@@ -1,8 +1,7 @@
 import {
   detectPlatform,
-  formatHotkey,
   getHotkeyManager,
-  rawHotkeyToParsedHotkey,
+  normalizeRegisterableHotkey,
 } from '@tanstack/hotkeys'
 import { onDestroy } from 'svelte'
 import { getDefaultHotkeysOptions } from './HotkeysCtx'
@@ -21,17 +20,6 @@ export interface CreateHotkeyOptions extends Omit<HotkeyOptions, 'target'> {
   target?: Document | Window // not html elements, use attachment instead
 }
 
-function normalizeHotkey(
-  hotkey: RegisterableHotkey,
-  options: CreateHotkeyOptions,
-): Hotkey {
-  const platform = options.platform ?? detectPlatform()
-
-  return typeof hotkey === 'string'
-    ? hotkey
-    : (formatHotkey(rawHotkeyToParsedHotkey(hotkey, platform)) as Hotkey)
-}
-
 function registerHotkey(
   target: HTMLElement | Document | Window,
   hotkey: RegisterableHotkey,
@@ -39,7 +27,10 @@ function registerHotkey(
   mergedOptions: CreateHotkeyOptions,
 ) {
   return getHotkeyManager().register(
-    normalizeHotkey(hotkey, mergedOptions),
+    normalizeRegisterableHotkey(
+      hotkey,
+      mergedOptions.platform ?? detectPlatform(),
+    ),
     callback,
     {
       ...mergedOptions,
@@ -82,7 +73,10 @@ export function createHotkey(
       ...resolvedOptions,
     } as CreateHotkeyOptions
 
-    const hotkeyStr = normalizeHotkey(resolvedHotkey, mergedOptions)
+    const hotkeyStr = normalizeRegisterableHotkey(
+      resolvedHotkey,
+      mergedOptions.platform ?? detectPlatform(),
+    )
     const { target: _t, ...optionsWithoutTarget } = mergedOptions
 
     if (registration?.isActive && lastHotkeyStr === hotkeyStr) {
@@ -150,7 +144,10 @@ export function createHotkeyAttachment(
         ...resolvedOptions,
       } as CreateHotkeyOptions
 
-      const hotkeyStr = normalizeHotkey(resolvedHotkey, mergedOptions)
+      const hotkeyStr = normalizeRegisterableHotkey(
+        resolvedHotkey,
+        mergedOptions.platform ?? detectPlatform(),
+      )
       const { target: _t, ...optionsWithoutTarget } = mergedOptions
 
       if (registration?.isActive && lastHotkeyStr === hotkeyStr) {

package/src/createHotkeys.svelte.ts

@@ -1,8 +1,7 @@
 import {
   detectPlatform,
-  formatHotkey,
   getHotkeyManager,
-  rawHotkeyToParsedHotkey,
+  normalizeRegisterableHotkey,
 } from '@tanstack/hotkeys'
 import { onDestroy } from 'svelte'
 import { SvelteMap, SvelteSet } from 'svelte/reactivity'
@@ -30,16 +29,6 @@ export interface CreateHotkeyDefinition {
   options?: MaybeGetter<CreateHotkeyOptions>
 }
 
-function normalizeHotkey(
-  hotkey: RegisterableHotkey,
-  options: CreateHotkeyOptions,
-): Hotkey {
-  const platform = options.platform ?? detectPlatform()
-  return typeof hotkey === 'string'
-    ? hotkey
-    : (formatHotkey(rawHotkeyToParsedHotkey(hotkey, platform)) as Hotkey)
-}
-
 type RegistrationRecord = {
   handle: HotkeyRegistrationHandle
   target: Document | HTMLElement | Window
@@ -121,7 +110,10 @@ export function createHotkeys(
         continue
       }
 
-      const hotkeyString = normalizeHotkey(resolvedHotkey, mergedOptions)
+      const hotkeyString = normalizeRegisterableHotkey(
+        resolvedHotkey,
+        mergedOptions.platform ?? detectPlatform(),
+      )
       const registrationKey = `${i}:${hotkeyString}`
       nextKeys.add(registrationKey)
       prepared.push({
@@ -225,7 +217,10 @@ export function createHotkeysAttachment(
           ...resolvedDefOptions,
         } as CreateHotkeyOptions
 
-        const hotkeyString = normalizeHotkey(resolvedHotkey, mergedOptions)
+        const hotkeyString = normalizeRegisterableHotkey(
+          resolvedHotkey,
+          mergedOptions.platform ?? detectPlatform(),
+        )
         const registrationKey = `${i}:${hotkeyString}`
         nextKeys.add(registrationKey)
         prepared.push({