@tanstack/solid-devtools 0.5.5 → 0.6.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/dist/esm/core.d.ts +1 -1
- package/dist/esm/core.js +4 -4
- package/dist/esm/core.js.map +1 -1
- package/package.json +2 -2
- package/src/core.tsx +12 -4
package/dist/esm/core.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { JSX } from 'solid-js';
|
|
2
2
|
import { ClientEventBusConfig, TanStackDevtoolsConfig, TanStackDevtoolsPlugin } from '@tanstack/devtools';
|
|
3
|
-
type SolidPluginRender = JSX.Element | (() => JSX.Element);
|
|
3
|
+
type SolidPluginRender = JSX.Element | ((el: HTMLDivElement | HTMLHeadingElement, theme: 'dark' | 'light') => JSX.Element);
|
|
4
4
|
export type TanStackDevtoolsSolidPlugin = Omit<TanStackDevtoolsPlugin, 'render' | 'name'> & {
|
|
5
5
|
/**
|
|
6
6
|
* The render function can be a SolidJS element or a function that returns a SolidJS element.
|
package/dist/esm/core.js
CHANGED
|
@@ -2,10 +2,10 @@ import { createComponent, template, use, Portal } from "solid-js/web";
|
|
|
2
2
|
import { TanStackDevtoolsCore } from "@tanstack/devtools";
|
|
3
3
|
import { createSignal, createEffect, onMount, onCleanup } from "solid-js";
|
|
4
4
|
var _tmpl$ = /* @__PURE__ */ template(`<div>`);
|
|
5
|
-
const convertRender = (el, Component) => createComponent(Portal, {
|
|
5
|
+
const convertRender = (el, Component, theme) => createComponent(Portal, {
|
|
6
6
|
mount: el,
|
|
7
7
|
get children() {
|
|
8
|
-
return typeof Component === "function" ?
|
|
8
|
+
return typeof Component === "function" ? Component(el, theme) : Component;
|
|
9
9
|
}
|
|
10
10
|
});
|
|
11
11
|
function SolidDevtoolsCore({
|
|
@@ -20,9 +20,9 @@ function SolidDevtoolsCore({
|
|
|
20
20
|
...plugin,
|
|
21
21
|
name: typeof plugin.name === "string" ? plugin.name : (
|
|
22
22
|
// The check above confirms that `plugin.name` is of Render type
|
|
23
|
-
(el) => convertRender(el, plugin.name)
|
|
23
|
+
(el, theme) => convertRender(el, plugin.name, theme)
|
|
24
24
|
),
|
|
25
|
-
render: (el) => convertRender(el, plugin.render)
|
|
25
|
+
render: (el, theme) => convertRender(el, plugin.render, theme)
|
|
26
26
|
}))
|
|
27
27
|
}));
|
|
28
28
|
let devToolRef;
|
package/dist/esm/core.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"core.js","sources":["../../src/core.tsx"],"sourcesContent":["import { TanStackDevtoolsCore } from '@tanstack/devtools'\nimport { createEffect, createSignal, onCleanup, onMount } from 'solid-js'\nimport { Portal } from 'solid-js/web'\nimport type { JSX } from 'solid-js'\nimport type {\n ClientEventBusConfig,\n TanStackDevtoolsConfig,\n TanStackDevtoolsPlugin,\n} from '@tanstack/devtools'\n\ntype SolidPluginRender
|
|
1
|
+
{"version":3,"file":"core.js","sources":["../../src/core.tsx"],"sourcesContent":["import { TanStackDevtoolsCore } from '@tanstack/devtools'\nimport { createEffect, createSignal, onCleanup, onMount } from 'solid-js'\nimport { Portal } from 'solid-js/web'\nimport type { JSX } from 'solid-js'\nimport type {\n ClientEventBusConfig,\n TanStackDevtoolsConfig,\n TanStackDevtoolsPlugin,\n} from '@tanstack/devtools'\n\ntype SolidPluginRender =\n | JSX.Element\n | ((\n el: HTMLDivElement | HTMLHeadingElement,\n theme: 'dark' | 'light',\n ) => JSX.Element)\nconst convertRender = (\n el: HTMLDivElement | HTMLHeadingElement,\n Component: SolidPluginRender,\n theme: 'dark' | 'light',\n) => (\n <Portal mount={el}>\n {typeof Component === 'function' ? Component(el, theme) : Component}\n </Portal>\n)\n\nexport type TanStackDevtoolsSolidPlugin = Omit<\n TanStackDevtoolsPlugin,\n 'render' | 'name'\n> & {\n /**\n * The render function can be a SolidJS element or a function that returns a SolidJS element.\n * If it's a function, it will be called to render the plugin, otherwise it will be rendered directly.\n *\n * Example:\n * ```ts\n * {\n * render: () => <CustomPluginComponent />,\n * }\n * ```\n * or\n * ```ts\n * {\n * render: <CustomPluginComponent />,\n * }\n * ```\n */\n render: SolidPluginRender\n /**\n * Name to be displayed in the devtools UI.\n * If a string, it will be used as the plugin name.\n * If a function, it will be called with the mount element.\n *\n * Example:\n * ```ts\n * {\n * name: \"Your Plugin\",\n * render: () => <CustomPluginComponent />,\n * }\n * ```\n * or\n * ```ts\n * {\n * name: <h1>Your Plugin title</h1>,\n * render: () => <CustomPluginComponent />,\n * }\n * ```\n */\n name: string | SolidPluginRender\n}\nexport interface TanStackDevtoolsInit {\n /**\n * Array of plugins to be used in the devtools.\n * Each plugin should have a `render` function that returns a React element or a function\n *\n * Example:\n * ```jsx\n * <TanStackDevtools\n * plugins={[\n * {\n * id: \"your-plugin-id\",\n * name: \"Your Plugin\",\n * render: <CustomPluginComponent />,\n * }\n * ]}\n * />\n * ```\n */\n plugins?: Array<TanStackDevtoolsSolidPlugin>\n /**\n * Configuration for the devtools shell. These configuration options are used to set the\n * initial state of the devtools when it is started for the first time. Afterwards,\n * the settings are persisted in local storage and changed through the settings panel.\n */\n config?: Partial<TanStackDevtoolsConfig>\n /**\n * Configuration for the TanStack Devtools client event bus.\n */\n eventBusConfig?: ClientEventBusConfig\n}\n\nexport default function SolidDevtoolsCore({\n config,\n plugins,\n eventBusConfig,\n}: TanStackDevtoolsInit) {\n const [devtools] = createSignal(\n new TanStackDevtoolsCore({\n config,\n eventBusConfig,\n plugins: plugins?.map((plugin) => ({\n ...plugin,\n name:\n typeof plugin.name === 'string'\n ? plugin.name\n : // The check above confirms that `plugin.name` is of Render type\n (el, theme) =>\n convertRender(el, plugin.name as SolidPluginRender, theme),\n render: (el: HTMLDivElement, theme: 'dark' | 'light') =>\n convertRender(el, plugin.render, theme),\n })),\n }),\n )\n let devToolRef: HTMLDivElement | undefined\n createEffect(() => {\n devtools().setConfig({ config })\n })\n onMount(() => {\n if (devToolRef) {\n devtools().mount(devToolRef)\n\n onCleanup(() => {\n devtools().unmount()\n })\n }\n })\n return <div style={{ position: 'absolute' }} ref={devToolRef} />\n}\n"],"names":["convertRender","el","Component","theme","_$createComponent","Portal","mount","children","SolidDevtoolsCore","config","plugins","eventBusConfig","devtools","createSignal","TanStackDevtoolsCore","map","plugin","name","render","devToolRef","createEffect","setConfig","onMount","onCleanup","unmount","_el$","_tmpl$","_ref$","_$use","style","setProperty"],"mappings":";;;;AAgBA,MAAMA,gBAAgBA,CACpBC,IACAC,WACAC,UAAuBC,gBAEtBC,QAAM;AAAA,EAACC,OAAOL;AAAAA,EAAE,IAAAM,WAAA;AAAA,WACd,OAAOL,cAAc,aAAaA,UAAUD,IAAIE,KAAK,IAAID;AAAAA,EAAS;AAAA,CAAA;AA+EvE,SAAwBM,kBAAkB;AAAA,EACxCC;AAAAA,EACAC;AAAAA,EACAC;AACoB,GAAG;AACvB,QAAM,CAACC,QAAQ,IAAIC,aACjB,IAAIC,qBAAqB;AAAA,IACvBL;AAAAA,IACAE;AAAAA,IACAD,SAASA,SAASK,IAAKC,CAAAA,YAAY;AAAA,MACjC,GAAGA;AAAAA,MACHC,MACE,OAAOD,OAAOC,SAAS,WACnBD,OAAOC;AAAAA;AAAAA,QAEP,CAAChB,IAAIE,UACHH,cAAcC,IAAIe,OAAOC,MAA2Bd,KAAK;AAAA;AAAA,MACjEe,QAAQA,CAACjB,IAAoBE,UAC3BH,cAAcC,IAAIe,OAAOE,QAAQf,KAAK;AAAA,IAAA,EACxC;AAAA,EAAA,CACH,CACH;AACA,MAAIgB;AACJC,eAAa,MAAM;AACjBR,aAAAA,EAAWS,UAAU;AAAA,MAAEZ;AAAAA,IAAAA,CAAQ;AAAA,EACjC,CAAC;AACDa,UAAQ,MAAM;AACZ,QAAIH,YAAY;AACdP,eAAAA,EAAWN,MAAMa,UAAU;AAE3BI,gBAAU,MAAM;AACdX,iBAAAA,EAAWY,QAAAA;AAAAA,MACb,CAAC;AAAA,IACH;AAAA,EACF,CAAC;AACD,UAAA,MAAA;AAAA,QAAAC,OAAAC,OAAAA;AAAA,QAAAC,QAAkDR;AAAU,WAAAQ,UAAA,aAAAC,IAAAD,OAAAF,IAAA,IAAVN,aAAUM;AAAAA,SAAAI,MAAAC,YAAA,YAAA,UAAA;AAAA,WAAAL;AAAAA,EAAA,GAAA;AAC9D;"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@tanstack/solid-devtools",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.6.1",
|
|
4
4
|
"description": "TanStack Devtools is a set of tools for building advanced devtools for your Solid application.",
|
|
5
5
|
"author": "Tanner Linsley",
|
|
6
6
|
"license": "MIT",
|
|
@@ -45,7 +45,7 @@
|
|
|
45
45
|
"src"
|
|
46
46
|
],
|
|
47
47
|
"dependencies": {
|
|
48
|
-
"@tanstack/devtools": "0.6.
|
|
48
|
+
"@tanstack/devtools": "0.6.5"
|
|
49
49
|
},
|
|
50
50
|
"devDependencies": {
|
|
51
51
|
"solid-js": "^1.9.7",
|
package/src/core.tsx
CHANGED
|
@@ -8,13 +8,19 @@ import type {
|
|
|
8
8
|
TanStackDevtoolsPlugin,
|
|
9
9
|
} from '@tanstack/devtools'
|
|
10
10
|
|
|
11
|
-
type SolidPluginRender =
|
|
11
|
+
type SolidPluginRender =
|
|
12
|
+
| JSX.Element
|
|
13
|
+
| ((
|
|
14
|
+
el: HTMLDivElement | HTMLHeadingElement,
|
|
15
|
+
theme: 'dark' | 'light',
|
|
16
|
+
) => JSX.Element)
|
|
12
17
|
const convertRender = (
|
|
13
18
|
el: HTMLDivElement | HTMLHeadingElement,
|
|
14
19
|
Component: SolidPluginRender,
|
|
20
|
+
theme: 'dark' | 'light',
|
|
15
21
|
) => (
|
|
16
22
|
<Portal mount={el}>
|
|
17
|
-
{typeof Component === 'function' ?
|
|
23
|
+
{typeof Component === 'function' ? Component(el, theme) : Component}
|
|
18
24
|
</Portal>
|
|
19
25
|
)
|
|
20
26
|
|
|
@@ -108,8 +114,10 @@ export default function SolidDevtoolsCore({
|
|
|
108
114
|
typeof plugin.name === 'string'
|
|
109
115
|
? plugin.name
|
|
110
116
|
: // The check above confirms that `plugin.name` is of Render type
|
|
111
|
-
(el) =>
|
|
112
|
-
|
|
117
|
+
(el, theme) =>
|
|
118
|
+
convertRender(el, plugin.name as SolidPluginRender, theme),
|
|
119
|
+
render: (el: HTMLDivElement, theme: 'dark' | 'light') =>
|
|
120
|
+
convertRender(el, plugin.render, theme),
|
|
113
121
|
})),
|
|
114
122
|
}),
|
|
115
123
|
)
|