@tanstack/hotkeys-devtools 0.3.3 → 0.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -44,7 +44,7 @@ Type-safe keyboard shortcuts for the web. Template-string bindings, parsed objec
44
44
  - Type-safe bindings — template strings (`Mod+Shift+S`, `Escape`) or parsed objects for full control
45
45
  - Flexible options — `keydown`/`keyup`, `preventDefault`, `stopPropagation`, conditional enabled, `requireReset`
46
46
  - Cross-platform Mod — maps to Cmd on macOS and Ctrl on Windows/Linux
47
- - Batteries included — validation + matching, sequences (Vim-style), key-state tracking, recorder UI helpers, React hooks, and devtools (in progress)
47
+ - Batteries included — validation + matching, sequences (Vim-style), key-state tracking, recorder UI helpers, framework adapters, and devtools
48
48
 
49
49
  ### <a href="https://tanstack.com/hotkeys">Read the docs →</a>
50
50
 
@@ -55,10 +55,10 @@ Type-safe keyboard shortcuts for the web. Template-string bindings, parsed objec
55
55
  >
56
56
  > - [**React Hotkeys**](https://tanstack.com/hotkeys/latest/docs/framework/react/react-hotkeys)
57
57
  > - [**Preact Hotkeys**](https://tanstack.com/hotkeys/latest/docs/framework/preact/preact-hotkeys)
58
- > - [**Solid Hotkeys**](https://tanstack.com/hotkeys/latest/docs/framework/solid/solid-hotkeys)
59
- > - Angular Hotkeys – needs a contributor!
58
+ > - [**Solid Hotkeys**](https://tanstack.com/hotkeys/latest/docs/framework/solid/reference)
59
+ > - [**Angular Hotkeys**](https://tanstack.com/hotkeys/latest/docs/framework/angular/reference)
60
+ > - [**Vue Hotkeys**](https://tanstack.com/hotkeys/latest/docs/framework/vue/reference)
60
61
  > - Svelte Hotkeys – needs a contributor!
61
- > - Vue Hotkeys – needs a contributor!
62
62
 
63
63
  ## Get Involved
64
64
 
@@ -1,5 +1,5 @@
1
- import { createContext, createEffect, createSignal, onCleanup, useContext } from "solid-js";
2
1
  import { createComponent } from "solid-js/web";
2
+ import { createContext, createEffect, createSignal, onCleanup, useContext } from "solid-js";
3
3
  import { HotkeyManager, KeyStateTracker, SequenceManager } from "@tanstack/hotkeys";
4
4
 
5
5
  //#region src/HotkeysContextProvider.tsx
@@ -1,8 +1,8 @@
1
1
  import { useHotkeysDevtoolsState } from "../HotkeysContextProvider.js";
2
2
  import { useStyles } from "../styles/use-styles.js";
3
3
  import { ActionButtons } from "./ActionButtons.js";
4
- import { For, Show, createMemo } from "solid-js";
5
4
  import { className, createComponent, effect, insert, template } from "solid-js/web";
5
+ import { For, Show, createMemo } from "solid-js";
6
6
  import { formatForDisplay, formatHotkeySequence } from "@tanstack/hotkeys";
7
7
 
8
8
  //#region src/components/DetailsPanel.tsx
@@ -1,7 +1,7 @@
1
1
  import { useHotkeysDevtoolsState } from "../HotkeysContextProvider.js";
2
2
  import { useStyles } from "../styles/use-styles.js";
3
- import { For, Show } from "solid-js";
4
3
  import { className, createComponent, effect, insert, memo, template } from "solid-js/web";
4
+ import { For, Show } from "solid-js";
5
5
  import { formatKeyForDebuggingDisplay } from "@tanstack/hotkeys";
6
6
 
7
7
  //#region src/components/HeldKeysTopbar.tsx
@@ -1,7 +1,7 @@
1
1
  import { useHotkeysDevtoolsState } from "../HotkeysContextProvider.js";
2
2
  import { useStyles } from "../styles/use-styles.js";
3
- import { For, Show, createEffect, createMemo, createSignal, on } from "solid-js";
4
3
  import { className, createComponent, delegateEvents, effect, insert, memo, template } from "solid-js/web";
4
+ import { For, Show, createEffect, createMemo, createSignal, on } from "solid-js";
5
5
  import { formatForDisplay, formatHotkeySequence } from "@tanstack/hotkeys";
6
6
  import clsx from "clsx";
7
7
 
@@ -3,8 +3,8 @@ import { useStyles } from "../styles/use-styles.js";
3
3
  import { HeldKeysBar } from "./HeldKeysTopbar.js";
4
4
  import { HotkeyList } from "./HotkeyList.js";
5
5
  import { DetailsPanel } from "./DetailsPanel.js";
6
- import { createMemo, createSignal, onCleanup, onMount } from "solid-js";
7
6
  import { className, createComponent, delegateEvents, effect, insert, setStyleProperty, template } from "solid-js/web";
7
+ import { createMemo, createSignal, onCleanup, onMount } from "solid-js";
8
8
  import { Header, HeaderLogo, MainPanel } from "@tanstack/devtools-ui";
9
9
 
10
10
  //#region src/components/Shell.tsx
package/dist/core.d.ts CHANGED
@@ -3,10 +3,8 @@ interface HotkeysDevtoolsInit {}
3
3
  declare const HotkeysDevtoolsCore: new () => {
4
4
  "__#private@#isMounted": boolean;
5
5
  "__#private@#isMounting": boolean;
6
- "__#private@#mountCb": (() => void) | null;
6
+ "__#private@#abortMount": boolean;
7
7
  "__#private@#dispose"?: () => void;
8
- "__#private@#Component": any;
9
- "__#private@#ThemeProvider": any;
10
8
  mount<T extends HTMLElement>(el: T, theme: "light" | "dark"): Promise<void>;
11
9
  unmount(): void;
12
10
  }, HotkeysDevtoolsCoreNoOp: new () => {
@@ -14,10 +12,8 @@ declare const HotkeysDevtoolsCore: new () => {
14
12
  unmount(): void;
15
13
  "__#private@#isMounted": boolean;
16
14
  "__#private@#isMounting": boolean;
17
- "__#private@#mountCb": (() => void) | null;
15
+ "__#private@#abortMount": boolean;
18
16
  "__#private@#dispose"?: () => void;
19
- "__#private@#Component": any;
20
- "__#private@#ThemeProvider": any;
21
17
  };
22
18
  //#endregion
23
19
  export { HotkeysDevtoolsCore, HotkeysDevtoolsInit };
package/dist/core.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import { constructCoreClass } from "@tanstack/devtools-utils/solid";
2
- import { lazy } from "solid-js";
3
2
 
4
3
  //#region src/core.tsx
5
- const [HotkeysDevtoolsCore, HotkeysDevtoolsCoreNoOp] = constructCoreClass(lazy(() => import("./HotkeysDevtools.js")));
4
+ const loadComponent = () => import("./HotkeysDevtools.js");
5
+ const [HotkeysDevtoolsCore, HotkeysDevtoolsCoreNoOp] = constructCoreClass(loadComponent);
6
6
 
7
7
  //#endregion
8
8
  export { HotkeysDevtoolsCore, HotkeysDevtoolsCoreNoOp };
package/dist/core.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"core.js","names":["constructCoreClass","lazy","Component","HotkeysDevtoolsInit","HotkeysDevtoolsCore","HotkeysDevtoolsCoreNoOp"],"sources":["../src/core.tsx"],"sourcesContent":["import { constructCoreClass } from '@tanstack/devtools-utils/solid'\nimport { lazy } from 'solid-js'\n\nconst Component = lazy(() => import('./HotkeysDevtools'))\n\nexport interface HotkeysDevtoolsInit {}\n\nconst [HotkeysDevtoolsCore, HotkeysDevtoolsCoreNoOp] =\n constructCoreClass(Component)\n\nexport { HotkeysDevtoolsCore, HotkeysDevtoolsCoreNoOp }\n"],"mappings":";;;;AAOA,MAAM,CAACI,qBAAqBC,2BAC1BL,mBALgBC,WAAW,OAAO,wBAAqB,CAK1B"}
1
+ {"version":3,"file":"core.js","names":["constructCoreClass","loadComponent","HotkeysDevtoolsInit","HotkeysDevtoolsCore","HotkeysDevtoolsCoreNoOp"],"sources":["../src/core.tsx"],"sourcesContent":["import { constructCoreClass } from '@tanstack/devtools-utils/solid'\n\nconst loadComponent = () => import('./HotkeysDevtools')\n\nexport interface HotkeysDevtoolsInit {}\n\nconst [HotkeysDevtoolsCore, HotkeysDevtoolsCoreNoOp] =\n constructCoreClass(loadComponent)\n\nexport { HotkeysDevtoolsCore, HotkeysDevtoolsCoreNoOp }\n"],"mappings":";;;AAEA,MAAMC,sBAAsB,OAAO;AAInC,MAAM,CAACE,qBAAqBC,2BAC1BJ,mBAAmBC,cAAc"}
package/dist/index.d.ts CHANGED
@@ -4,10 +4,8 @@ import { HotkeysDevtoolsInit } from "./core.js";
4
4
  declare const HotkeysDevtoolsCore: new () => {
5
5
  "__#private@#isMounted": boolean;
6
6
  "__#private@#isMounting": boolean;
7
- "__#private@#mountCb": (() => void) | null;
7
+ "__#private@#abortMount": boolean;
8
8
  "__#private@#dispose"?: () => void;
9
- "__#private@#Component": any;
10
- "__#private@#ThemeProvider": any;
11
9
  mount<T extends HTMLElement>(el: T, theme: "light" | "dark"): Promise<void>;
12
10
  unmount(): void;
13
11
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@tanstack/hotkeys-devtools",
3
- "version": "0.3.3",
3
+ "version": "0.4.1",
4
4
  "description": "Devtools for TanStack Hotkeys",
5
5
  "author": "Tanner Linsley",
6
6
  "license": "MIT",
@@ -37,11 +37,11 @@
37
37
  "src"
38
38
  ],
39
39
  "peerDependencies": {
40
- "@tanstack/hotkeys": "0.3.3"
40
+ "@tanstack/hotkeys": "0.4.1"
41
41
  },
42
42
  "dependencies": {
43
- "@tanstack/devtools-ui": "^0.4.4",
44
- "@tanstack/devtools-utils": "^0.3.0",
43
+ "@tanstack/devtools-ui": "^0.5.0",
44
+ "@tanstack/devtools-utils": "^0.3.2",
45
45
  "clsx": "^2.1.1",
46
46
  "goober": "^2.1.18",
47
47
  "solid-js": "^1.9.11"
package/src/core.tsx CHANGED
@@ -1,11 +1,10 @@
1
1
  import { constructCoreClass } from '@tanstack/devtools-utils/solid'
2
- import { lazy } from 'solid-js'
3
2
 
4
- const Component = lazy(() => import('./HotkeysDevtools'))
3
+ const loadComponent = () => import('./HotkeysDevtools')
5
4
 
6
5
  export interface HotkeysDevtoolsInit {}
7
6
 
8
7
  const [HotkeysDevtoolsCore, HotkeysDevtoolsCoreNoOp] =
9
- constructCoreClass(Component)
8
+ constructCoreClass(loadComponent)
10
9
 
11
10
  export { HotkeysDevtoolsCore, HotkeysDevtoolsCoreNoOp }