Skip to content

Commit 53fdead

Browse files
committed
Merge branch 'main' into fix/501-svelte-adapter-exports
2 parents 0c166f6 + 375c58f commit 53fdead

92 files changed

Lines changed: 1295 additions & 415 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.changeset/calm-buses-connect.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

docs/architecture.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -146,26 +146,26 @@ The devtools shell is a Solid.js application that renders the entire devtools UI
146146
- **`setConfig(config)`** -- Updates configuration and plugins at runtime. Plugins are reactive: adding or removing them updates the tab bar immediately.
147147

148148
The shell renders:
149-
- A **trigger button** (the floating devtools toggle, customizable or replaceable)
149+
- A **trigger button** (the floating rainbow palm mark, customizable or replaceable)
150150
- A **resizable Workbench panel** (docked to the top or bottom of the viewport, resizable via pointer or keyboard)
151151
- A compact **36px TanStack Devtools header** with Plugins, Marketplace, SEO, and Settings destinations. The palm emblem is inline SVG, so it stays sharp and takes its colour from the theme.
152152
- A fixed-height **44px secondary strip** for plugin and SEO navigation. It scrolls horizontally when space is limited, and a pull tab on its bottom edge folds it away behind the header. Folding changes nothing else — the panel keeps its height and the destination content keeps running — so the tab is rendered only on the destinations that have a strip.
153153
- A separate **Marketplace** header tab that does not disturb mounted plugin panes
154154
- A **settings panel** for theme, hotkeys, position, and other preferences
155155
- Up to three simultaneous **plugin mount frames**, divided into equal widths by static separators
156156

157-
Settings and UI state (panel size, position, active tab, theme) are persisted in `localStorage` so they survive page reloads.
157+
Settings and UI state (panel size, position, active tab, theme, and whether the secondary strip is folded) are persisted in `localStorage` so they survive page reloads.
158158

159159
The core shell owns the Workbench header, navigation, mount-frame geometry, separators, and surrounding light/dark surfaces. Each external plugin owns everything inside its mount target; core styling deliberately does not reach into plugin descendants. Detaching the Workbench uses a fixed `100vh` Picture-in-Picture layout and restores the stored docked height when reattached.
160160

161161
#### Workbench surfaces and gutters
162162

163163
Two rules keep the shell reading as one surface:
164164

165-
- **Chrome versus canvas.** The header and every secondary strip paint the brand surface (cream in light mode, near-black in dark mode) and close with a translucent ink hairline. Destination content and plugin mount frames paint the workspace surface. A plugin pane can paint any colour it likes, so the separator between panes uses a mid-tone border that stays visible against both.
165+
- **Chrome versus canvas.** The header and every secondary strip paint the brand surface (cream in light mode, near-black in dark mode) and close with a translucent ink hairline. Destination content and plugin mount frames paint the workspace surface. A plugin pane can paint any colour it likes. The resize gutter between panes is invisible at rest and paints a line on hover or keyboard focus.
166166
- **One gutter.** `WORKBENCH_GUTTER` (16px, or `WORKBENCH_GUTTER_NARROW` at 12px below 430px) is the single inline gutter. The header, the strips, and each destination's content all start there, so the left edge is one column instead of three. `MainPanel withPadding` uses the same value.
167167

168-
Colour comes from the semantic theme only. Raw hex values in core-owned source are rejected by `tests/semantic-color-usage.test.ts` unless they carry a narrow, path-scoped `semantic-color-exempt` marker — currently only third-party network marks and the source-inspector highlight alpha. Status colours (success, warning, error, info) mark real state; identity accents do not compete with them, so a card that is both featured and active keeps the neutral outline and lets its badge say which it is.
168+
Colour comes from the semantic theme only. Raw hex values in core-owned source are rejected by `tests/semantic-color-usage.test.ts` unless they carry a narrow, path-scoped `semantic-color-exempt` marker. The current exemptions are third-party network marks, the source-inspector highlight alpha, and the trigger rainbow mark. Status colours (success, warning, error, info) mark real state; identity accents do not compete with them, so a card that is both featured and active keeps the neutral outline and lets its badge say which it is.
169169

170170
### @tanstack/devtools-ui -- Component Library
171171

@@ -190,15 +190,17 @@ This client is a singleton (`devtoolsEventClient`) used by both the core shell a
190190
Each framework adapter is a thin wrapper that bridges its framework's component model to the core Solid.js shell. The pattern is the same across all adapters:
191191

192192
1. **Creates a `TanStackDevtoolsCore` instance** with the user's plugins and config.
193-
2. **Mounts it to a DOM element** using the framework's lifecycle hooks (`useEffect` in React, `onMounted` in Vue, `onMount` in Solid).
194-
3. **Converts framework-specific plugin definitions** into the core's DOM-based `render(el, theme)` interface. Each adapter defines its own plugin type (e.g. `TanStackDevtoolsReactPlugin`) that accepts framework-native components, then wraps them in a `render` callback that the core calls with a target DOM element and the current theme.
195-
4. **Uses the framework's portal/teleport mechanism** to render plugin components into the core's DOM containers:
193+
2. **Mounts it to a DOM element** using the framework's lifecycle APIs, such as `useEffect` in React, `onMounted` in Vue, `$effect` in Svelte, and `onMount` in Solid.
194+
3. **Converts framework-specific plugin definitions** into the core's DOM-based `render(el, props)` interface. Each adapter defines its own plugin type (e.g. `TanStackDevtoolsReactPlugin`) that accepts framework-native components, then wraps them in a `render` callback that the core calls with a target DOM element and `{ theme, devtoolsOpen }`.
195+
4. **Uses the framework's rendering API** to render plugin components into the core's DOM containers:
196196
- **React** -- `createPortal()` from `react-dom`
197197
- **Vue** -- `<Teleport :to="'#' + plugin.id" />`
198198
- **Solid** -- `<Portal mount={el} />`
199199
- **Preact** -- Same portal pattern as React
200+
- **Svelte** -- `mount(component, { target: el, props })`
201+
- **Angular** -- `createComponent()` with the container's environment injector
200202

201-
The key insight: the core shell is always Solid.js, but your plugins run in **your** framework. A React plugin is a real React component rendered by React's `createPortal` into a DOM element that the Solid.js shell created. A Vue plugin is a real Vue component rendered by Vue's `<Teleport>`. The adapters bridge this gap so you never need to think about Solid.js unless you want to.
203+
The key insight: the core shell is always Solid.js, but your plugins run in **your** framework. Each adapter receives the same plugin props and renders a native framework component into a DOM element created by the Solid.js shell. The adapters bridge this gap so you never need to think about Solid.js unless you want to.
202204

203205
### What an adapter does NOT do
204206

docs/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ The `config` object is mainly focused around user interaction with the devtools
3535
{ position: 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right' | 'middle-left' | 'middle-right' }
3636
```
3737

38-
- `triggerMode` - How the trigger is placed. `'fixed'` anchors it to `position`; `'floating'` lets you drag the trigger anywhere on screen (and throw itit glides with momentum and springs back off the edges). The floating spot is persisted in local storage.
38+
- `triggerMode` - How the trigger is placed. `'floating'` (the default) lets you drag the trigger anywhere on screen, and throw it: it glides with momentum and springs back off the edges. `'fixed'` anchors it to `position`. The floating spot is persisted in local storage.
3939

4040
```ts
4141
{ triggerMode: 'fixed' | 'floating' }

docs/devtools-utils.md

Lines changed: 27 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ const [MyPlugin, NoOpPlugin] = createReactPlugin({
7777

7878
The returned tuple contains two factory functions:
7979

80-
- **`Plugin()`** -- returns a plugin object with `name`, `id`, `defaultOpen`, and a `render` function that renders your `Component` with the current theme.
80+
- **`Plugin()`** -- returns a plugin object with `name`, `id`, `defaultOpen`, and a `render` function that renders your `Component` with the current plugin props.
8181
- **`NoOpPlugin()`** -- returns a plugin object with the same metadata but a `render` function that renders an empty fragment. Use this for production builds where you want to strip devtools out.
8282

8383
A common pattern for tree-shaking:
@@ -90,15 +90,15 @@ const ActivePlugin = process.env.NODE_ENV === 'development' ? MyPlugin : NoOpPlu
9090

9191
### createReactPanel
9292

93-
For library authors shipping a class-based devtools core that exposes `mount(el, theme)` and `unmount()` methods. This factory wraps that class in a React component that handles mounting into a `div`, passing the theme, and cleaning up on unmount.
93+
For library authors shipping a class-based devtools core that exposes `mount(el, props)` and `unmount()` methods. This factory wraps that class in a React component that handles mounting into a `div`, passing the complete plugin props, and cleaning up on unmount.
9494

9595
**Signature:**
9696

9797
```ts
9898
function createReactPanel<
99-
TComponentProps extends DevtoolsPanelProps | undefined,
99+
TComponentProps extends DevtoolsPanelProps,
100100
TCoreDevtoolsClass extends {
101-
mount: (el: HTMLElement, theme: 'light' | 'dark') => void
101+
mount: (el: HTMLElement, props: DevtoolsPanelProps) => void
102102
unmount: () => void
103103
},
104104
>(CoreClass: new () => TCoreDevtoolsClass): readonly [Panel, NoOpPanel]
@@ -107,10 +107,13 @@ function createReactPanel<
107107
**Usage:**
108108

109109
```tsx
110-
import { createReactPanel } from '@tanstack/devtools-utils/react'
110+
import {
111+
createReactPanel,
112+
type DevtoolsPanelProps,
113+
} from '@tanstack/devtools-utils/react'
111114

112115
class MyDevtoolsCore {
113-
mount(el: HTMLElement, theme: 'light' | 'dark') {
116+
mount(el: HTMLElement, props: DevtoolsPanelProps) {
114117
// render your devtools UI into el
115118
}
116119
unmount() {
@@ -129,9 +132,9 @@ const [MyPlugin, NoOpPlugin] = createReactPlugin({
129132

130133
The returned `Panel` component:
131134
- Creates a `div` with `height: 100%` and stores a ref to it.
132-
- Instantiates `CoreClass` on mount and calls `core.mount(el, theme)`.
135+
- Instantiates `CoreClass` on mount and calls `core.mount(el, props)`.
133136
- Calls `core.unmount()` on cleanup.
134-
- Re-mounts when the `theme` prop changes.
137+
- Re-mounts when the plugin props change.
135138

136139
`NoOpPanel` renders an empty fragment and does nothing.
137140

@@ -262,14 +265,18 @@ The panel component accepts `theme` and `devtoolsProps` as props. It mounts the
262265

263266
### createSveltePlugin
264267

265-
The Svelte factory takes a `name` string and a Svelte component as separate arguments, similar to the Vue API.
268+
The Svelte factory takes the plugin metadata and Svelte component in a configuration object.
266269

267270
**Signature:**
268271

269272
```ts
270273
function createSveltePlugin<TComponentProps extends Record<string, any>>(
271-
name: string,
272-
component: Component<TComponentProps>,
274+
config: {
275+
name: string
276+
id?: string
277+
defaultOpen?: boolean
278+
Component: Component<TComponentProps>
279+
},
273280
): readonly [Plugin, NoOpPlugin]
274281
```
275282

@@ -279,13 +286,18 @@ function createSveltePlugin<TComponentProps extends Record<string, any>>(
279286
import { createSveltePlugin } from '@tanstack/devtools-utils/svelte'
280287
import MyStorePanel from './MyStorePanel.svelte'
281288
282-
const [MyPlugin, NoOpPlugin] = createSveltePlugin('My Store', MyStorePanel)
289+
const [MyPlugin, NoOpPlugin] = createSveltePlugin({
290+
Component: MyStorePanel,
291+
name: 'My Store',
292+
id: 'my-store',
293+
defaultOpen: true,
294+
})
283295
```
284296

285297
The returned functions:
286298

287-
- **`Plugin(props?)`** -- returns `{ name, component, props }` where `component` is your Svelte component.
288-
- **`NoOpPlugin(props?)`** -- returns `{ name, component: NoOpComponent, props }` where the component renders nothing visible.
299+
- **`Plugin(props?)`** -- returns the plugin metadata, component, and forwarded props.
300+
- **`NoOpPlugin(props?)`** -- preserves the plugin metadata and props but replaces the component with one that renders nothing visible.
289301

290302
Both accept an optional `props` object that gets forwarded to the component on mount.
291303

@@ -299,7 +311,7 @@ import { createSveltePanel } from '@tanstack/devtools-utils/svelte'
299311
const [MyPanel, NoOpPanel] = createSveltePanel(MyDevtoolsCore)
300312
```
301313

302-
The panel accepts `theme` and `devtoolsProps` props. It creates a `div` element, mounts the core instance into it, and calls `unmount()` on cleanup.
314+
The panel constructs the core without arguments. It creates a `div` element, passes the complete `{ theme, devtoolsOpen }` plugin props to `mount()`, and registers `unmount()` with Svelte's component cleanup lifecycle.
303315

304316
## Angular
305317

docs/framework/react/adapter.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Each plugin describes a tab in the devtools panel:
2828
```ts
2929
type PluginRender =
3030
| JSX.Element
31-
| ((el: HTMLElement, theme: 'dark' | 'light') => JSX.Element)
31+
| ((el: HTMLElement, props: TanStackDevtoolsPluginProps) => JSX.Element)
3232

3333
type TanStackDevtoolsReactPlugin = {
3434
id?: string
@@ -38,7 +38,7 @@ type TanStackDevtoolsReactPlugin = {
3838
}
3939
```
4040
41-
- **`render`** can be a JSX element (simplest -- just pass `<YourPanel />`) or a function that receives the container element and current theme. The function form is useful when you need to access the raw DOM element or respond to theme changes.
41+
- **`render`** can be a JSX element (simplest -- just pass `<YourPanel />`) or a function that receives the container element and current `{ theme, devtoolsOpen }` props. The function form is useful when you need to access the raw DOM element or respond to plugin state changes.
4242
- **`name`** works the same way -- use a string for plain text, or JSX / a function for custom tab titles.
4343
- **`id`** is an optional unique identifier. If omitted, it is generated from the name.
4444
- **`defaultOpen`** marks the plugin as initially active when no other plugins are open.

docs/framework/svelte/adapter.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,14 +38,16 @@ type TanStackDevtoolsSveltePlugin = {
3838
| Field | Type | Description |
3939
| --- | --- | --- |
4040
| `id` | `string` (optional) | Unique identifier for the plugin. |
41-
| `component` | `Component<any>` | The Svelte component to render as the plugin panel content. |
42-
| `name` | `string \| Component<any>` | Display name for the tab title. Can be a plain string or a Svelte component for custom rendering. |
43-
| `props` | `Record<string, any>` (optional) | Additional props passed to the plugin component on mount. |
41+
| `component` | `Component<any>` | The Svelte component to render as the plugin panel content. It receives the shared `theme` and `devtoolsOpen` props. |
42+
| `name` | `string \| Component<any>` | Display name for the tab title. A custom Svelte component receives the same merged plugin props. |
43+
| `props` | `Record<string, any>` (optional) | Additional props merged with the shared plugin props when the component mounts. |
4444
| `defaultOpen` | `boolean` (optional) | Whether this plugin tab should be open by default. |
4545
4646
## Key Difference from Other Frameworks
4747
48-
The Svelte adapter uses `component` (a Svelte component reference) instead of `render` (a JSX element) in plugin definitions. Props are provided through the `props` field and passed to the component via Svelte's `mount()` API, rather than being embedded directly in a JSX expression.
48+
The Svelte adapter uses `component` (a Svelte component reference) instead of `render` (a JSX element) in plugin definitions. It passes `{ theme, devtoolsOpen, ...plugin.props }` to the component through Svelte's `mount()` API.
49+
50+
When the core renders a plugin again, the adapter updates the existing Svelte host with the latest component and props. If the component identity is unchanged, its state and lifecycle remain intact. The adapter unmounts the host when the plugin is destroyed or the Devtools instance shuts down.
4951
5052
```svelte
5153
<!-- Svelte: pass component reference + props -->

docs/framework/svelte/basic-setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,6 @@ Import the desired devtools and provide them to the `TanStackDevtools` component
4848
<TanStackDevtools {plugins} />
4949
```
5050

51-
> Note: The Svelte adapter uses `component` (a Svelte component reference) instead of `render` (a JSX element) in plugin definitions. Additional props can be provided via the `props` field and are passed to the component on mount.
51+
> Note: The Svelte adapter uses `component` (a Svelte component reference) instead of `render` (a JSX element) in plugin definitions. Components receive the shared `theme` and `devtoolsOpen` props. Additional values from the plugin's `props` field are merged into the same object when the component mounts.
5252
5353
Finally, add any additional configuration you desire to the `TanStackDevtools` component. More information can be found under the [TanStack Devtools Configuration](../../configuration) section.

0 commit comments

Comments
 (0)