@tanstack/svelte-hotkeys-devtools 0.1.0

package/README.md

@@ -0,0 +1,140 @@
+<div align="center">
+  <picture>
+    <source
+      media="(prefers-color-scheme: dark)"
+      srcset="https://tanstack.com/api/readme/hotkeys.png?theme=dark"
+    />
+    <source
+      media="(prefers-color-scheme: light)"
+      srcset="https://tanstack.com/api/readme/hotkeys.png"
+    />
+    <img
+      src="https://tanstack.com/api/readme/hotkeys.png"
+      alt="TanStack Hotkeys"
+      width="900"
+    />
+  </picture>
+</div>
+
+<br />
+
+<div align="center">
+	<a href="https://www.npmjs.com/package/@tanstack/hotkeys" target="\_parent">
+	  <img alt="" src="https://img.shields.io/npm/dm/@tanstack/hotkeys.svg" alt="npm downloads" />
+	</a>
+	<a href="https://github.com/TanStack/hotkeys" target="\_parent">
+	  <img alt="" src="https://img.shields.io/github/stars/TanStack/hotkeys.svg?style=social&label=Star" alt="GitHub stars" />
+	</a>
+	<a href="https://bundlephobia.com/result?p=@tanstack/react-hotkeys@latest" target="\_parent">
+	  <img alt="" src="https://badgen.net/bundlephobia/minzip/@tanstack/react-hotkeys@latest" alt="Bundle size" />
+	</a>
+</div>
+
+<div align="center">
+	<a href="#badge">
+	  <img alt="semantic-release" src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg">
+	</a>
+	<a href="#badge">
+	  <img src="https://img.shields.io/github/v/release/tanstack/hotkeys" alt="Release"/>
+	</a>
+	<a href="https://twitter.com/tan_stack">
+	  <img src="https://img.shields.io/twitter/follow/tan_stack.svg?style=social" alt="Follow @TanStack"/>
+	</a>
+</div>
+
+<div align="center">
+
+### [Become a Sponsor!](https://github.com/sponsors/tannerlinsley/)
+
+</div>
+
+# TanStack Hotkeys
+
+> [!NOTE]
+> 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.
+
+- Type-safe bindings — template strings (`Mod+Shift+S`, `Escape`) or parsed objects for full control
+- Flexible options — `keydown`/`keyup`, `preventDefault`, `stopPropagation`, conditional enabled, `requireReset`
+- Cross-platform Mod — maps to Cmd on macOS and Ctrl on Windows/Linux
+- Batteries included — validation + matching, sequences (Vim-style), key-state tracking, recorder UI helpers, framework adapters, and devtools
+
+### <a href="https://tanstack.com/hotkeys">Read the docs →</a>
+
+<br />
+
+> [!NOTE]
+> You may know **TanStack Hotkeys** by our adapter names, too!
+>
+> - [**Alpine Hotkeys**](https://tanstack.com/hotkeys/latest/docs/framework/alpine/quick-start)
+> - [**Ember Hotkeys**](https://tanstack.com/hotkeys/latest/docs/framework/ember/quick-start)
+> - [**Octane Hotkeys**](https://tanstack.com/hotkeys/latest/docs/framework/octane/quick-start)
+> - [**React Hotkeys**](https://tanstack.com/hotkeys/latest/docs/framework/react/react-hotkeys)
+> - [**Preact Hotkeys**](https://tanstack.com/hotkeys/latest/docs/framework/preact/preact-hotkeys)
+> - [**Solid Hotkeys**](https://tanstack.com/hotkeys/latest/docs/framework/solid/reference)
+> - [**Angular Hotkeys**](https://tanstack.com/hotkeys/latest/docs/framework/angular/reference)
+> - [**Vue Hotkeys**](https://tanstack.com/hotkeys/latest/docs/framework/vue/reference)
+> - [**Lit Hotkeys**](https://tanstack.com/hotkeys/latest/docs/framework/lit/reference)
+> - [**Svelte Hotkeys**](https://tanstack.com/hotkeys/latest/docs/framework/svelte/reference)
+
+## Get Involved
+
+- We welcome issues and pull requests!
+- Participate in [GitHub discussions](https://github.com/TanStack/hotkeys/discussions)
+- Chat with the community on [Discord](https://discord.com/invite/WrRKjPJ)
+- See [CONTRIBUTING.md](./CONTRIBUTING.md) for setup instructions
+
+## Partners
+
+<div align="center">
+
+<table align="center">
+  <tr>
+    <td>
+      <a href="https://www.coderabbit.ai/?via=tanstack&dub_id=aCcEEdAOqqutX6OS" >
+        <picture>
+          <source media="(prefers-color-scheme: dark)" srcset="https://tanstack.com/assets/coderabbit-dark-D643Zkrv.svg" height="40" />
+          <source media="(prefers-color-scheme: light)" srcset="https://tanstack.com/assets/coderabbit-light-CIzGLYU_.svg" height="40" />
+          <img src="https://tanstack.com/assets/coderabbit-light-DVMJ2jHi.svg" height="40" alt="CodeRabbit" />
+        </picture>
+      </a>
+    </td>
+    <td>
+      <a href="https://www.cloudflare.com?utm_source=tanstack">
+        <picture>
+          <source media="(prefers-color-scheme: dark)" srcset="https://tanstack.com/assets/cloudflare-white-Co-Tyjbl.svg" height="60" />
+          <source media="(prefers-color-scheme: light)" srcset="https://tanstack.com/assets/cloudflare-black-6Ojsn8yh.svg" height="60" />
+          <img src="https://tanstack.com/assets/cloudflare-black-CPufaW0B.svg" height="60" alt="Cloudflare" />
+        </picture>
+      </a>
+    </td>
+  </tr>
+</table>
+
+<div align="center">
+<img src="media/partner_logo.svg" alt="Keys & you?" height="65">
+<p>
+We're looking for TanStack Hotkeys Partners to join our mission! Partner with us to push the boundaries of TanStack Hotkeys and build amazing things together.
+</p>
+<a href="mailto:partners@tanstack.com?subject=TanStack Hotkeys Partnership"><b>LET'S CHAT</b></a>
+</div>
+
+</div>
+
+## Explore the TanStack Ecosystem
+
+- <a href="https://github.com/tanstack/config"><b>TanStack Config</b></a> – Tooling for JS/TS packages
+- <a href="https://github.com/tanstack/db"><b>TanStack DB</b></a> – Reactive sync client store
+- <a href="https://github.com/tanstack/devtools"><b>TanStack DevTools</b></a> – Unified devtools panel
+- <a href="https://github.com/tanstack/form"><b>TanStack Form</b></a> – Type‑safe form state
+- <a href="https://github.com/tanstack/hotkeys"><b>TanStack Hotkeys</b></a> – Type‑safe keyboard shortcuts
+- <a href="https://github.com/tanstack/query"><b>TanStack Query</b></a> – Async state & caching
+- <a href="https://github.com/tanstack/ranger"><b>TanStack Ranger</b></a> – Range & slider primitives
+- <a href="https://github.com/tanstack/router"><b>TanStack Router</b></a> – Type‑safe routing, caching & URL state
+- <a href="https://github.com/tanstack/start"><b>TanStack Start</b></a> – Full‑stack SSR & streaming
+- <a href="https://github.com/tanstack/store"><b>TanStack Store</b></a> – Reactive data store
+- <a href="https://github.com/tanstack/table"><b>TanStack Table</b></a> – Headless datagrids
+- <a href="https://github.com/tanstack/virtual"><b>TanStack Virtual</b></a> – Virtualized rendering
+
+… and more at <a href="https://tanstack.com"><b>TanStack.com »</b></a>

package/dist/SvelteHotkeysDevtools.d.ts

@@ -0,0 +1,6 @@
+import type { DevtoolsPanelProps } from '@tanstack/devtools-utils/svelte';
+import type { Component } from 'svelte';
+export interface HotkeysDevtoolsSvelteInit extends Partial<DevtoolsPanelProps> {
+}
+export declare const HotkeysDevtoolsPanel: Component<HotkeysDevtoolsSvelteInit, {}, string>;
+export declare const HotkeysDevtoolsPanelNoOp: Component<HotkeysDevtoolsSvelteInit, {}, string>;

package/dist/SvelteHotkeysDevtools.js

@@ -0,0 +1,15 @@
+import { createSveltePanel } from '@tanstack/devtools-utils/svelte';
+import { HotkeysDevtoolsCore } from '@tanstack/hotkeys-devtools/production';
+const panels = createSveltePanel(HotkeysDevtoolsCore);
+function withDefaults(Panel) {
+    return (internals, props) => Panel(internals, {
+        get theme() {
+            return props.theme ?? 'dark';
+        },
+        get devtoolsOpen() {
+            return props.devtoolsOpen ?? true;
+        },
+    });
+}
+export const HotkeysDevtoolsPanel = withDefaults(panels[0]);
+export const HotkeysDevtoolsPanelNoOp = withDefaults(panels[1]);

package/dist/index.d.ts

@@ -0,0 +1,16 @@
+import * as Devtools from './SvelteHotkeysDevtools';
+export declare const HotkeysDevtoolsPanel: import("svelte").Component<Devtools.HotkeysDevtoolsSvelteInit, {}, string>;
+export declare const hotkeysDevtoolsPlugin: ((props?: Devtools.HotkeysDevtoolsSvelteInit | undefined) => {
+    component: import("svelte").Component<Devtools.HotkeysDevtoolsSvelteInit, {}, string>;
+    props: Devtools.HotkeysDevtoolsSvelteInit | undefined;
+    name: string;
+    id?: string;
+    defaultOpen?: boolean;
+}) | ((props?: Devtools.HotkeysDevtoolsSvelteInit | undefined) => {
+    component: import("svelte/legacy").LegacyComponentType;
+    props: Devtools.HotkeysDevtoolsSvelteInit | undefined;
+    name: string;
+    id?: string;
+    defaultOpen?: boolean;
+});
+export type { HotkeysDevtoolsSvelteInit } from './SvelteHotkeysDevtools';

package/dist/index.js

@@ -0,0 +1,8 @@
+import * as Devtools from './SvelteHotkeysDevtools';
+import * as plugin from './plugin';
+export const HotkeysDevtoolsPanel = process.env.NODE_ENV !== 'development'
+    ? Devtools.HotkeysDevtoolsPanelNoOp
+    : Devtools.HotkeysDevtoolsPanel;
+export const hotkeysDevtoolsPlugin = process.env.NODE_ENV !== 'development'
+    ? plugin.hotkeysDevtoolsNoOpPlugin
+    : plugin.hotkeysDevtoolsPlugin;

package/dist/plugin.d.ts

@@ -0,0 +1,14 @@
+declare const hotkeysDevtoolsPlugin: (props?: import("./SvelteHotkeysDevtools").HotkeysDevtoolsSvelteInit | undefined) => {
+    component: import("svelte").Component<import("./SvelteHotkeysDevtools").HotkeysDevtoolsSvelteInit, {}, string>;
+    props: import("./SvelteHotkeysDevtools").HotkeysDevtoolsSvelteInit | undefined;
+    name: string;
+    id?: string;
+    defaultOpen?: boolean;
+}, hotkeysDevtoolsNoOpPlugin: (props?: import("./SvelteHotkeysDevtools").HotkeysDevtoolsSvelteInit | undefined) => {
+    component: import("svelte/legacy").LegacyComponentType;
+    props: import("./SvelteHotkeysDevtools").HotkeysDevtoolsSvelteInit | undefined;
+    name: string;
+    id?: string;
+    defaultOpen?: boolean;
+};
+export { hotkeysDevtoolsPlugin, hotkeysDevtoolsNoOpPlugin };

package/dist/plugin.js

@@ -0,0 +1,7 @@
+import { createSveltePlugin } from '@tanstack/devtools-utils/svelte';
+import { HotkeysDevtoolsPanel } from './SvelteHotkeysDevtools';
+const [hotkeysDevtoolsPlugin, hotkeysDevtoolsNoOpPlugin] = createSveltePlugin({
+    name: 'TanStack Hotkeys',
+    Component: HotkeysDevtoolsPanel,
+});
+export { hotkeysDevtoolsPlugin, hotkeysDevtoolsNoOpPlugin };

package/dist/production.d.ts

@@ -0,0 +1,3 @@
+export { HotkeysDevtoolsPanel } from './SvelteHotkeysDevtools';
+export { hotkeysDevtoolsPlugin } from './plugin';
+export type { HotkeysDevtoolsSvelteInit } from './SvelteHotkeysDevtools';

package/dist/production.js

@@ -0,0 +1,2 @@
+export { HotkeysDevtoolsPanel } from './SvelteHotkeysDevtools';
+export { hotkeysDevtoolsPlugin } from './plugin';

package/package.json

@@ -0,0 +1,74 @@
+{
+  "name": "@tanstack/svelte-hotkeys-devtools",
+  "version": "0.1.0",
+  "description": "Svelte devtools for TanStack Hotkeys",
+  "author": "Tanner Linsley",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/TanStack/hotkeys.git",
+    "directory": "packages/svelte-hotkeys-devtools"
+  },
+  "homepage": "https://tanstack.com/hotkeys",
+  "funding": {
+    "type": "github",
+    "url": "https://github.com/sponsors/tannerlinsley"
+  },
+  "keywords": [
+    "svelte",
+    "tanstack",
+    "keys",
+    "devtools",
+    "hotkeys",
+    "keyboard"
+  ],
+  "scripts": {
+    "clean": "premove ./build ./dist",
+    "lint": "eslint ./src",
+    "lint:fix": "eslint ./src --fix",
+    "test:eslint": "eslint ./src",
+    "test:lib": "vitest --passWithNoTests",
+    "test:lib:dev": "pnpm test:lib --watch",
+    "test:types": "tsc",
+    "build": "svelte-package --input ./src --output ./dist",
+    "test:build": "publint --strict && node ../../scripts/verify-package.ts"
+  },
+  "type": "module",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "svelte": "./dist/index.js",
+      "import": "./dist/index.js"
+    },
+    "./production": {
+      "types": "./dist/production.d.ts",
+      "svelte": "./dist/production.js",
+      "import": "./dist/production.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "sideEffects": false,
+  "engines": {
+    "node": ">=20"
+  },
+  "files": [
+    "dist"
+  ],
+  "peerDependencies": {
+    "svelte": "^5.25.0"
+  },
+  "dependencies": {
+    "@tanstack/devtools-utils": "^0.7.0",
+    "@tanstack/hotkeys-devtools": "workspace:*"
+  },
+  "devDependencies": {
+    "@sveltejs/package": "^3.0.0",
+    "@sveltejs/vite-plugin-svelte": "^7.3.1",
+    "@typescript-eslint/parser": "^8.71.0",
+    "eslint-plugin-svelte": "^3.23.0",
+    "svelte": "^5.57.1"
+  },
+  "module": "dist/index.js",
+  "svelte": "./dist/index.js"
+}