@tanstack/preact-hotkeys-devtools 0.3.0

package/README.md

@@ -0,0 +1,122 @@
+<div align="center">
+  <img src="./media/header_hotkeys.png" alt="TanStack Hotkeys" />
+</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 pre-alpha (prototyping phase). 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, React hooks, and devtools (in progress)
+
+### <a href="https://tanstack.com/hotkeys">Read the docs →</a>
+
+<br />
+
+> [!NOTE]
+> You may know **TanStack Hotkeys** by our adapter names, too!
+>
+> - [**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/solid-hotkeys)
+> - Angular Hotkeys – needs a contributor!
+> - Svelte Hotkeys – needs a contributor!
+> - Vue Hotkeys – needs a contributor!
+
+## 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/PreactHotkeysDevtools.d.ts

@@ -0,0 +1,7 @@
+import { DevtoolsPanelProps } from "@tanstack/devtools-utils/preact";
+
+//#region src/PreactHotkeysDevtools.d.ts
+interface HotkeysDevtoolsPreactInit extends DevtoolsPanelProps {}
+//#endregion
+export { HotkeysDevtoolsPreactInit };
+//# sourceMappingURL=PreactHotkeysDevtools.d.ts.map

package/dist/PreactHotkeysDevtools.js

@@ -0,0 +1,9 @@
+import { createPreactPanel } from "@tanstack/devtools-utils/preact";
+import { HotkeysDevtoolsCore } from "@tanstack/hotkeys-devtools";
+
+//#region src/PreactHotkeysDevtools.tsx
+const [HotkeysDevtoolsPanel, HotkeysDevtoolsPanelNoOp] = createPreactPanel(HotkeysDevtoolsCore);
+
+//#endregion
+export { HotkeysDevtoolsPanel, HotkeysDevtoolsPanelNoOp };
+//# sourceMappingURL=PreactHotkeysDevtools.js.map

package/dist/PreactHotkeysDevtools.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PreactHotkeysDevtools.js","names":[],"sources":["../src/PreactHotkeysDevtools.tsx"],"sourcesContent":["import { createPreactPanel } from '@tanstack/devtools-utils/preact'\nimport { HotkeysDevtoolsCore } from '@tanstack/hotkeys-devtools'\nimport type { DevtoolsPanelProps } from '@tanstack/devtools-utils/preact'\n\nexport interface HotkeysDevtoolsPreactInit extends DevtoolsPanelProps {}\n\nconst [HotkeysDevtoolsPanel, HotkeysDevtoolsPanelNoOp] =\n  createPreactPanel(HotkeysDevtoolsCore)\n\nexport { HotkeysDevtoolsPanel, HotkeysDevtoolsPanelNoOp }\n"],"mappings":";;;;AAMA,MAAM,CAAC,sBAAsB,4BAC3B,kBAAkB,oBAAoB"}

package/dist/index.d.ts

@@ -0,0 +1,15 @@
+import { HotkeysDevtoolsPreactInit } from "./PreactHotkeysDevtools.js";
+import * as _tanstack_devtools_utils_preact0 from "@tanstack/devtools-utils/preact";
+import * as preact from "preact";
+
+//#region src/index.d.ts
+declare const HotkeysDevtoolsPanel: (props: _tanstack_devtools_utils_preact0.DevtoolsPanelProps | undefined) => preact.JSX.Element;
+declare const hotkeysDevtoolsPlugin: () => {
+  render: (_el: HTMLElement, theme: "light" | "dark") => preact.JSX.Element;
+  name: string;
+  id?: string;
+  defaultOpen?: boolean;
+};
+//#endregion
+export { HotkeysDevtoolsPanel, type HotkeysDevtoolsPreactInit, hotkeysDevtoolsPlugin };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,10 @@
+import { HotkeysDevtoolsPanel as HotkeysDevtoolsPanel$1, HotkeysDevtoolsPanelNoOp } from "./PreactHotkeysDevtools.js";
+import { hotkeysDevtoolsNoOpPlugin, hotkeysDevtoolsPlugin as hotkeysDevtoolsPlugin$1 } from "./plugin.js";
+
+//#region src/index.ts
+const HotkeysDevtoolsPanel = process.env.NODE_ENV !== "development" ? HotkeysDevtoolsPanelNoOp : HotkeysDevtoolsPanel$1;
+const hotkeysDevtoolsPlugin = process.env.NODE_ENV !== "development" ? hotkeysDevtoolsNoOpPlugin : hotkeysDevtoolsPlugin$1;
+
+//#endregion
+export { HotkeysDevtoolsPanel, hotkeysDevtoolsPlugin };
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["Devtools.HotkeysDevtoolsPanelNoOp","Devtools.HotkeysDevtoolsPanel","plugin.hotkeysDevtoolsNoOpPlugin","plugin.hotkeysDevtoolsPlugin"],"sources":["../src/index.ts"],"sourcesContent":["import * as Devtools from './PreactHotkeysDevtools'\nimport * as plugin from './plugin'\n\nexport const HotkeysDevtoolsPanel =\n  process.env.NODE_ENV !== 'development'\n    ? Devtools.HotkeysDevtoolsPanelNoOp\n    : Devtools.HotkeysDevtoolsPanel\n\nexport const hotkeysDevtoolsPlugin =\n  process.env.NODE_ENV !== 'development'\n    ? plugin.hotkeysDevtoolsNoOpPlugin\n    : plugin.hotkeysDevtoolsPlugin\n\nexport type { HotkeysDevtoolsPreactInit } from './PreactHotkeysDevtools'\n"],"mappings":";;;;AAGA,MAAa,uBACX,QAAQ,IAAI,aAAa,gBACrBA,2BACAC;AAEN,MAAa,wBACX,QAAQ,IAAI,aAAa,gBACrBC,4BACAC"}

package/dist/plugin.js

@@ -0,0 +1,12 @@
+import { HotkeysDevtoolsPanel } from "./PreactHotkeysDevtools.js";
+import { createPreactPlugin } from "@tanstack/devtools-utils/preact";
+
+//#region src/plugin.tsx
+const [hotkeysDevtoolsPlugin, hotkeysDevtoolsNoOpPlugin] = createPreactPlugin({
+	name: "TanStack Hotkeys",
+	Component: HotkeysDevtoolsPanel
+});
+
+//#endregion
+export { hotkeysDevtoolsNoOpPlugin, hotkeysDevtoolsPlugin };
+//# sourceMappingURL=plugin.js.map

package/dist/plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.js","names":[],"sources":["../src/plugin.tsx"],"sourcesContent":["import { createPreactPlugin } from '@tanstack/devtools-utils/preact'\nimport { HotkeysDevtoolsPanel } from './PreactHotkeysDevtools'\n\nconst [hotkeysDevtoolsPlugin, hotkeysDevtoolsNoOpPlugin] = createPreactPlugin({\n  name: 'TanStack Hotkeys',\n  Component: HotkeysDevtoolsPanel,\n})\n\nexport { hotkeysDevtoolsPlugin, hotkeysDevtoolsNoOpPlugin }\n"],"mappings":";;;;AAGA,MAAM,CAAC,uBAAuB,6BAA6B,mBAAmB;CAC5E,MAAM;CACN,WAAW;CACZ,CAAC"}

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@tanstack/preact-hotkeys-devtools",
+  "version": "0.3.0",
+  "description": "Preact devtools for TanStack Hotkeys",
+  "author": "Tanner Linsley",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/TanStack/hotkeys.git",
+    "directory": "packages/preact-hotkeys-devtools"
+  },
+  "homepage": "https://tanstack.com/hotkeys",
+  "funding": {
+    "type": "github",
+    "url": "https://github.com/sponsors/tannerlinsley"
+  },
+  "keywords": [
+    "preact",
+    "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": "tsdown"
+  },
+  "type": "module",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": "./dist/index.js",
+    "./package.json": "./package.json"
+  },
+  "sideEffects": false,
+  "engines": {
+    "node": ">=18"
+  },
+  "files": [
+    "dist/",
+    "src"
+  ],
+  "peerDependencies": {
+    "preact": ">=10.0.0"
+  },
+  "dependencies": {
+    "@tanstack/devtools-utils": "^0.3.0",
+    "@tanstack/hotkeys-devtools": "workspace:*"
+  },
+  "devDependencies": {
+    "@preact/preset-vite": "^2.10.2",
+    "preact": "^10.27.2"
+  }
+}

package/src/PreactHotkeysDevtools.tsx

@@ -0,0 +1,10 @@
+import { createPreactPanel } from '@tanstack/devtools-utils/preact'
+import { HotkeysDevtoolsCore } from '@tanstack/hotkeys-devtools'
+import type { DevtoolsPanelProps } from '@tanstack/devtools-utils/preact'
+
+export interface HotkeysDevtoolsPreactInit extends DevtoolsPanelProps {}
+
+const [HotkeysDevtoolsPanel, HotkeysDevtoolsPanelNoOp] =
+  createPreactPanel(HotkeysDevtoolsCore)
+
+export { HotkeysDevtoolsPanel, HotkeysDevtoolsPanelNoOp }

package/src/index.ts

@@ -0,0 +1,14 @@
+import * as Devtools from './PreactHotkeysDevtools'
+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
+
+export type { HotkeysDevtoolsPreactInit } from './PreactHotkeysDevtools'

package/src/plugin.tsx

@@ -0,0 +1,9 @@
+import { createPreactPlugin } from '@tanstack/devtools-utils/preact'
+import { HotkeysDevtoolsPanel } from './PreactHotkeysDevtools'
+
+const [hotkeysDevtoolsPlugin, hotkeysDevtoolsNoOpPlugin] = createPreactPlugin({
+  name: 'TanStack Hotkeys',
+  Component: HotkeysDevtoolsPanel,
+})
+
+export { hotkeysDevtoolsPlugin, hotkeysDevtoolsNoOpPlugin }