You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit f1584c7
Browse filesBrowse the repository at this point in the historyBrowse files
Align Svelte panel construction and plugin metadata with the other framework factories, use compiled Svelte components to own panel and no-op lifecycles, forward shared plugin props through the Svelte adapter, and update mounted component props without resetting their state.
Copy file name to clipboardExpand all lines: docs/architecture.md
+6-4Lines changed: 6 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -190,15 +190,17 @@ This client is a singleton (`devtoolsEventClient`) used by both the core shell a
190
190
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:
191
191
192
192
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:
196
196
-**React** -- `createPortal()` from `react-dom`
197
197
-**Vue** -- `<Teleport :to="'#' + plugin.id" />`
198
198
-**Solid** -- `<Portal mount={el} />`
199
199
-**Preact** -- Same portal pattern as React
200
+
-**Svelte** -- `mount(component, { target: el, props })`
201
+
-**Angular** -- `createComponent()` with the container's environment injector
200
202
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.
-**`Plugin()`**--returnsapluginobjectwith`name`, `id`, `defaultOpen`, anda`render`function that renders your `Component` with the current theme.
80
+
-**`Plugin()`**--returnsapluginobjectwith`name`, `id`, `defaultOpen`, anda`render`function that renders your `Component` with the current plugin props.
81
81
- **`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.
@@ -38,7 +38,7 @@ type TanStackDevtoolsReactPlugin = {
38
38
}
39
39
```
40
40
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.
42
42
- **`name`** works the same way -- use a string for plain text, or JSX / a function for custom tab titles.
43
43
- **`id`** is an optional unique identifier. If omitted, it is generated from the name.
44
44
- **`defaultOpen`** marks the plugin as initially active when no other plugins are open.
Copy file name to clipboardExpand all lines: docs/framework/svelte/adapter.md
+6-4Lines changed: 6 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,14 +38,16 @@ type TanStackDevtoolsSveltePlugin = {
38
38
| Field | Type | Description |
39
39
| --- | --- | --- |
40
40
| `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. |
44
44
| `defaultOpen` | `boolean` (optional) | Whether this plugin tab should be open by default. |
45
45
46
46
## Key Difference from Other Frameworks
47
47
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.
Copy file name to clipboardExpand all lines: docs/framework/svelte/basic-setup.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -48,6 +48,6 @@ Import the desired devtools and provide them to the `TanStackDevtools` component
48
48
<TanStackDevtools {plugins} />
49
49
```
50
50
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.
52
52
53
53
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