@tanstack/react-devtools 0.4.6 → 0.5.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/devtools.js +6 -4
- package/dist/esm/devtools.js.map +1 -1
- package/package.json +2 -11
- package/src/devtools.tsx +6 -5
- package/dist/cjs/devtools.cjs +0 -66
- package/dist/cjs/devtools.cjs.map +0 -1
- package/dist/cjs/devtools.d.cts +0 -76
- package/dist/cjs/index.cjs +0 -9
- package/dist/cjs/index.cjs.map +0 -1
- package/dist/cjs/index.d.cts +0 -3
- package/dist/cjs/production.cjs +0 -7
- package/dist/cjs/production.cjs.map +0 -1
- package/dist/cjs/production.d.cts +0 -3
package/dist/esm/devtools.js
CHANGED
|
@@ -28,9 +28,11 @@ const TanStackDevtools = ({
|
|
|
28
28
|
...plugin,
|
|
29
29
|
name: typeof plugin.name === "string" ? plugin.name : (
|
|
30
30
|
// The check above confirms that `plugin.name` is of Render type
|
|
31
|
-
() => {
|
|
31
|
+
(e) => {
|
|
32
32
|
setTitleContainer(
|
|
33
|
-
|
|
33
|
+
e.ownerDocument.getElementById(
|
|
34
|
+
PLUGIN_TITLE_CONTAINER_ID
|
|
35
|
+
) || null
|
|
34
36
|
);
|
|
35
37
|
convertRender(
|
|
36
38
|
plugin.name,
|
|
@@ -38,9 +40,9 @@ const TanStackDevtools = ({
|
|
|
38
40
|
);
|
|
39
41
|
}
|
|
40
42
|
),
|
|
41
|
-
render: () => {
|
|
43
|
+
render: (e) => {
|
|
42
44
|
setPluginContainer(
|
|
43
|
-
|
|
45
|
+
e.ownerDocument.getElementById(PLUGIN_CONTAINER_ID) || null
|
|
44
46
|
);
|
|
45
47
|
convertRender(plugin.render, setPluginComponent);
|
|
46
48
|
}
|
package/dist/esm/devtools.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"devtools.js","sources":["../../src/devtools.tsx"],"sourcesContent":["import React, { useEffect, useRef, useState } from 'react'\nimport {\n PLUGIN_CONTAINER_ID,\n PLUGIN_TITLE_CONTAINER_ID,\n TanStackDevtoolsCore,\n} from '@tanstack/devtools'\nimport { createPortal } from 'react-dom'\nimport type { JSX, ReactElement } from 'react'\nimport type {\n ClientEventBusConfig,\n TanStackDevtoolsConfig,\n TanStackDevtoolsPlugin,\n} from '@tanstack/devtools'\n\ntype PluginRender = JSX.Element | (() => JSX.Element)\n\nexport type TanStackDevtoolsReactPlugin = Omit<\n TanStackDevtoolsPlugin,\n 'render' | 'name'\n> & {\n /**\n * The render function can be a React element or a function that returns a React 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 * ```jsx\n * {\n * render: () => <CustomPluginComponent />,\n * }\n * ```\n * or\n * ```jsx\n * {\n * render: <CustomPluginComponent />,\n * }\n * ```\n */\n render: PluginRender\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 * ```jsx\n * {\n * name: \"Your Plugin\",\n * render: () => <CustomPluginComponent />,\n * }\n * ```\n * or\n * ```jsx\n * {\n * name: <h1>Your Plugin title</h1>,\n * render: () => <CustomPluginComponent />,\n * }\n * ```\n */\n name: string | PluginRender\n}\n\nexport interface TanStackDevtoolsReactInit {\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<TanStackDevtoolsReactPlugin>\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\nconst convertRender = (\n Component: PluginRender,\n setComponent: React.Dispatch<React.SetStateAction<JSX.Element | null>>,\n) => {\n setComponent(typeof Component === 'function' ? Component() : Component)\n}\n\nexport const TanStackDevtools = ({\n plugins,\n config,\n eventBusConfig,\n}: TanStackDevtoolsReactInit): ReactElement | null => {\n const devToolRef = useRef<HTMLDivElement>(null)\n const [pluginContainer, setPluginContainer] = useState<HTMLElement | null>(\n null,\n )\n const [titleContainer, setTitleContainer] = useState<HTMLElement | null>(null)\n const [PluginComponent, setPluginComponent] = useState<JSX.Element | null>(\n null,\n )\n const [TitleComponent, setTitleComponent] = useState<JSX.Element | null>(null)\n const [devtools] = useState(\n () =>\n new TanStackDevtoolsCore({\n config,\n eventBusConfig,\n plugins: plugins?.map((plugin) => {\n return {\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 () => {\n setTitleContainer(\n
|
|
1
|
+
{"version":3,"file":"devtools.js","sources":["../../src/devtools.tsx"],"sourcesContent":["import React, { useEffect, useRef, useState } from 'react'\nimport {\n PLUGIN_CONTAINER_ID,\n PLUGIN_TITLE_CONTAINER_ID,\n TanStackDevtoolsCore,\n} from '@tanstack/devtools'\nimport { createPortal } from 'react-dom'\nimport type { JSX, ReactElement } from 'react'\nimport type {\n ClientEventBusConfig,\n TanStackDevtoolsConfig,\n TanStackDevtoolsPlugin,\n} from '@tanstack/devtools'\n\ntype PluginRender = JSX.Element | (() => JSX.Element)\n\nexport type TanStackDevtoolsReactPlugin = Omit<\n TanStackDevtoolsPlugin,\n 'render' | 'name'\n> & {\n /**\n * The render function can be a React element or a function that returns a React 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 * ```jsx\n * {\n * render: () => <CustomPluginComponent />,\n * }\n * ```\n * or\n * ```jsx\n * {\n * render: <CustomPluginComponent />,\n * }\n * ```\n */\n render: PluginRender\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 * ```jsx\n * {\n * name: \"Your Plugin\",\n * render: () => <CustomPluginComponent />,\n * }\n * ```\n * or\n * ```jsx\n * {\n * name: <h1>Your Plugin title</h1>,\n * render: () => <CustomPluginComponent />,\n * }\n * ```\n */\n name: string | PluginRender\n}\n\nexport interface TanStackDevtoolsReactInit {\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<TanStackDevtoolsReactPlugin>\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\nconst convertRender = (\n Component: PluginRender,\n setComponent: React.Dispatch<React.SetStateAction<JSX.Element | null>>,\n) => {\n setComponent(typeof Component === 'function' ? Component() : Component)\n}\n\nexport const TanStackDevtools = ({\n plugins,\n config,\n eventBusConfig,\n}: TanStackDevtoolsReactInit): ReactElement | null => {\n const devToolRef = useRef<HTMLDivElement>(null)\n const [pluginContainer, setPluginContainer] = useState<HTMLElement | null>(\n null,\n )\n const [titleContainer, setTitleContainer] = useState<HTMLElement | null>(null)\n const [PluginComponent, setPluginComponent] = useState<JSX.Element | null>(\n null,\n )\n const [TitleComponent, setTitleComponent] = useState<JSX.Element | null>(null)\n const [devtools] = useState(\n () =>\n new TanStackDevtoolsCore({\n config,\n eventBusConfig,\n plugins: plugins?.map((plugin) => {\n return {\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 (e) => {\n setTitleContainer(\n e.ownerDocument.getElementById(\n PLUGIN_TITLE_CONTAINER_ID,\n ) || null,\n )\n convertRender(\n plugin.name as PluginRender,\n setTitleComponent,\n )\n },\n render: (e) => {\n setPluginContainer(\n e.ownerDocument.getElementById(PLUGIN_CONTAINER_ID) || null,\n )\n convertRender(plugin.render, setPluginComponent)\n },\n }\n }),\n }),\n )\n useEffect(() => {\n if (devToolRef.current) {\n devtools.mount(devToolRef.current)\n }\n\n return () => devtools.unmount()\n }, [devtools])\n\n return (\n <>\n <div style={{ position: 'absolute' }} ref={devToolRef} />\n {pluginContainer && PluginComponent\n ? createPortal(<>{PluginComponent}</>, pluginContainer)\n : null}\n {titleContainer && TitleComponent\n ? createPortal(<>{TitleComponent}</>, titleContainer)\n : null}\n </>\n )\n}\n"],"names":[],"mappings":";;;;AA4FA,MAAM,gBAAgB,CACpB,WACA,iBACG;AACH,eAAa,OAAO,cAAc,aAAa,UAAA,IAAc,SAAS;AACxE;AAEO,MAAM,mBAAmB,CAAC;AAAA,EAC/B;AAAA,EACA;AAAA,EACA;AACF,MAAsD;AACpD,QAAM,aAAa,OAAuB,IAAI;AAC9C,QAAM,CAAC,iBAAiB,kBAAkB,IAAI;AAAA,IAC5C;AAAA,EAAA;AAEF,QAAM,CAAC,gBAAgB,iBAAiB,IAAI,SAA6B,IAAI;AAC7E,QAAM,CAAC,iBAAiB,kBAAkB,IAAI;AAAA,IAC5C;AAAA,EAAA;AAEF,QAAM,CAAC,gBAAgB,iBAAiB,IAAI,SAA6B,IAAI;AAC7E,QAAM,CAAC,QAAQ,IAAI;AAAA,IACjB,MACE,IAAI,qBAAqB;AAAA,MACvB;AAAA,MACA;AAAA,MACA,SAAS,SAAS,IAAI,CAAC,WAAW;AAChC,eAAO;AAAA,UACL,GAAG;AAAA,UACH,MACE,OAAO,OAAO,SAAS,WACnB,OAAO;AAAA;AAAA,YAEP,CAAC,MAAM;AACL;AAAA,gBACE,EAAE,cAAc;AAAA,kBACd;AAAA,gBAAA,KACG;AAAA,cAAA;AAEP;AAAA,gBACE,OAAO;AAAA,gBACP;AAAA,cAAA;AAAA,YAEJ;AAAA;AAAA,UACN,QAAQ,CAAC,MAAM;AACb;AAAA,cACE,EAAE,cAAc,eAAe,mBAAmB,KAAK;AAAA,YAAA;AAEzD,0BAAc,OAAO,QAAQ,kBAAkB;AAAA,UACjD;AAAA,QAAA;AAAA,MAEJ,CAAC;AAAA,IAAA,CACF;AAAA,EAAA;AAEL,YAAU,MAAM;AACd,QAAI,WAAW,SAAS;AACtB,eAAS,MAAM,WAAW,OAAO;AAAA,IACnC;AAEA,WAAO,MAAM,SAAS,QAAA;AAAA,EACxB,GAAG,CAAC,QAAQ,CAAC;AAEb,SACE,qBAAA,UAAA,EACE,UAAA;AAAA,IAAA,oBAAC,SAAI,OAAO,EAAE,UAAU,WAAA,GAAc,KAAK,YAAY;AAAA,IACtD,mBAAmB,kBAChB,6CAAgB,UAAA,gBAAA,CAAgB,GAAK,eAAe,IACpD;AAAA,IACH,kBAAkB,iBACf,6CAAgB,UAAA,eAAA,CAAe,GAAK,cAAc,IAClD;AAAA,EAAA,GACN;AAEJ;"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@tanstack/react-devtools",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.5.1",
|
|
4
4
|
"description": "TanStack Devtools is a set of tools for building advanced devtools for your React application.",
|
|
5
5
|
"author": "Tanner Linsley",
|
|
6
6
|
"license": "MIT",
|
|
@@ -20,27 +20,18 @@
|
|
|
20
20
|
],
|
|
21
21
|
"type": "module",
|
|
22
22
|
"types": "dist/esm/index.d.ts",
|
|
23
|
-
"main": "dist/cjs/index.cjs",
|
|
24
23
|
"module": "dist/esm/index.js",
|
|
25
24
|
"exports": {
|
|
26
25
|
".": {
|
|
27
26
|
"import": {
|
|
28
27
|
"types": "./dist/esm/index.d.ts",
|
|
29
28
|
"default": "./dist/esm/index.js"
|
|
30
|
-
},
|
|
31
|
-
"require": {
|
|
32
|
-
"types": "./dist/cjs/index.d.cts",
|
|
33
|
-
"default": "./dist/cjs/index.cjs"
|
|
34
29
|
}
|
|
35
30
|
},
|
|
36
31
|
"./production": {
|
|
37
32
|
"import": {
|
|
38
33
|
"types": "./dist/esm/production.d.ts",
|
|
39
34
|
"default": "./dist/esm/production.js"
|
|
40
|
-
},
|
|
41
|
-
"require": {
|
|
42
|
-
"types": "./dist/cjs/production.d.cts",
|
|
43
|
-
"default": "./dist/cjs/production.cjs"
|
|
44
35
|
}
|
|
45
36
|
},
|
|
46
37
|
"./package.json": "./package.json"
|
|
@@ -54,7 +45,7 @@
|
|
|
54
45
|
"src"
|
|
55
46
|
],
|
|
56
47
|
"dependencies": {
|
|
57
|
-
"@tanstack/devtools": "0.
|
|
48
|
+
"@tanstack/devtools": "0.5.1"
|
|
58
49
|
},
|
|
59
50
|
"devDependencies": {
|
|
60
51
|
"@eslint-react/eslint-plugin": "^1.48.5",
|
package/src/devtools.tsx
CHANGED
|
@@ -123,19 +123,20 @@ export const TanStackDevtools = ({
|
|
|
123
123
|
typeof plugin.name === 'string'
|
|
124
124
|
? plugin.name
|
|
125
125
|
: // The check above confirms that `plugin.name` is of Render type
|
|
126
|
-
() => {
|
|
126
|
+
(e) => {
|
|
127
127
|
setTitleContainer(
|
|
128
|
-
|
|
129
|
-
|
|
128
|
+
e.ownerDocument.getElementById(
|
|
129
|
+
PLUGIN_TITLE_CONTAINER_ID,
|
|
130
|
+
) || null,
|
|
130
131
|
)
|
|
131
132
|
convertRender(
|
|
132
133
|
plugin.name as PluginRender,
|
|
133
134
|
setTitleComponent,
|
|
134
135
|
)
|
|
135
136
|
},
|
|
136
|
-
render: () => {
|
|
137
|
+
render: (e) => {
|
|
137
138
|
setPluginContainer(
|
|
138
|
-
|
|
139
|
+
e.ownerDocument.getElementById(PLUGIN_CONTAINER_ID) || null,
|
|
139
140
|
)
|
|
140
141
|
convertRender(plugin.render, setPluginComponent)
|
|
141
142
|
},
|
package/dist/cjs/devtools.cjs
DELETED
|
@@ -1,66 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
|
|
3
|
-
const jsxRuntime = require("react/jsx-runtime");
|
|
4
|
-
const react = require("react");
|
|
5
|
-
const devtools = require("@tanstack/devtools");
|
|
6
|
-
const reactDom = require("react-dom");
|
|
7
|
-
const convertRender = (Component, setComponent) => {
|
|
8
|
-
setComponent(typeof Component === "function" ? Component() : Component);
|
|
9
|
-
};
|
|
10
|
-
const TanStackDevtools = ({
|
|
11
|
-
plugins,
|
|
12
|
-
config,
|
|
13
|
-
eventBusConfig
|
|
14
|
-
}) => {
|
|
15
|
-
const devToolRef = react.useRef(null);
|
|
16
|
-
const [pluginContainer, setPluginContainer] = react.useState(
|
|
17
|
-
null
|
|
18
|
-
);
|
|
19
|
-
const [titleContainer, setTitleContainer] = react.useState(null);
|
|
20
|
-
const [PluginComponent, setPluginComponent] = react.useState(
|
|
21
|
-
null
|
|
22
|
-
);
|
|
23
|
-
const [TitleComponent, setTitleComponent] = react.useState(null);
|
|
24
|
-
const [devtools$1] = react.useState(
|
|
25
|
-
() => new devtools.TanStackDevtoolsCore({
|
|
26
|
-
config,
|
|
27
|
-
eventBusConfig,
|
|
28
|
-
plugins: plugins?.map((plugin) => {
|
|
29
|
-
return {
|
|
30
|
-
...plugin,
|
|
31
|
-
name: typeof plugin.name === "string" ? plugin.name : (
|
|
32
|
-
// The check above confirms that `plugin.name` is of Render type
|
|
33
|
-
() => {
|
|
34
|
-
setTitleContainer(
|
|
35
|
-
document.getElementById(devtools.PLUGIN_TITLE_CONTAINER_ID) || null
|
|
36
|
-
);
|
|
37
|
-
convertRender(
|
|
38
|
-
plugin.name,
|
|
39
|
-
setTitleComponent
|
|
40
|
-
);
|
|
41
|
-
}
|
|
42
|
-
),
|
|
43
|
-
render: () => {
|
|
44
|
-
setPluginContainer(
|
|
45
|
-
document.getElementById(devtools.PLUGIN_CONTAINER_ID) || null
|
|
46
|
-
);
|
|
47
|
-
convertRender(plugin.render, setPluginComponent);
|
|
48
|
-
}
|
|
49
|
-
};
|
|
50
|
-
})
|
|
51
|
-
})
|
|
52
|
-
);
|
|
53
|
-
react.useEffect(() => {
|
|
54
|
-
if (devToolRef.current) {
|
|
55
|
-
devtools$1.mount(devToolRef.current);
|
|
56
|
-
}
|
|
57
|
-
return () => devtools$1.unmount();
|
|
58
|
-
}, [devtools$1]);
|
|
59
|
-
return /* @__PURE__ */ jsxRuntime.jsxs(jsxRuntime.Fragment, { children: [
|
|
60
|
-
/* @__PURE__ */ jsxRuntime.jsx("div", { style: { position: "absolute" }, ref: devToolRef }),
|
|
61
|
-
pluginContainer && PluginComponent ? reactDom.createPortal(/* @__PURE__ */ jsxRuntime.jsx(jsxRuntime.Fragment, { children: PluginComponent }), pluginContainer) : null,
|
|
62
|
-
titleContainer && TitleComponent ? reactDom.createPortal(/* @__PURE__ */ jsxRuntime.jsx(jsxRuntime.Fragment, { children: TitleComponent }), titleContainer) : null
|
|
63
|
-
] });
|
|
64
|
-
};
|
|
65
|
-
exports.TanStackDevtools = TanStackDevtools;
|
|
66
|
-
//# sourceMappingURL=devtools.cjs.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"devtools.cjs","sources":["../../src/devtools.tsx"],"sourcesContent":["import React, { useEffect, useRef, useState } from 'react'\nimport {\n PLUGIN_CONTAINER_ID,\n PLUGIN_TITLE_CONTAINER_ID,\n TanStackDevtoolsCore,\n} from '@tanstack/devtools'\nimport { createPortal } from 'react-dom'\nimport type { JSX, ReactElement } from 'react'\nimport type {\n ClientEventBusConfig,\n TanStackDevtoolsConfig,\n TanStackDevtoolsPlugin,\n} from '@tanstack/devtools'\n\ntype PluginRender = JSX.Element | (() => JSX.Element)\n\nexport type TanStackDevtoolsReactPlugin = Omit<\n TanStackDevtoolsPlugin,\n 'render' | 'name'\n> & {\n /**\n * The render function can be a React element or a function that returns a React 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 * ```jsx\n * {\n * render: () => <CustomPluginComponent />,\n * }\n * ```\n * or\n * ```jsx\n * {\n * render: <CustomPluginComponent />,\n * }\n * ```\n */\n render: PluginRender\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 * ```jsx\n * {\n * name: \"Your Plugin\",\n * render: () => <CustomPluginComponent />,\n * }\n * ```\n * or\n * ```jsx\n * {\n * name: <h1>Your Plugin title</h1>,\n * render: () => <CustomPluginComponent />,\n * }\n * ```\n */\n name: string | PluginRender\n}\n\nexport interface TanStackDevtoolsReactInit {\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<TanStackDevtoolsReactPlugin>\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\nconst convertRender = (\n Component: PluginRender,\n setComponent: React.Dispatch<React.SetStateAction<JSX.Element | null>>,\n) => {\n setComponent(typeof Component === 'function' ? Component() : Component)\n}\n\nexport const TanStackDevtools = ({\n plugins,\n config,\n eventBusConfig,\n}: TanStackDevtoolsReactInit): ReactElement | null => {\n const devToolRef = useRef<HTMLDivElement>(null)\n const [pluginContainer, setPluginContainer] = useState<HTMLElement | null>(\n null,\n )\n const [titleContainer, setTitleContainer] = useState<HTMLElement | null>(null)\n const [PluginComponent, setPluginComponent] = useState<JSX.Element | null>(\n null,\n )\n const [TitleComponent, setTitleComponent] = useState<JSX.Element | null>(null)\n const [devtools] = useState(\n () =>\n new TanStackDevtoolsCore({\n config,\n eventBusConfig,\n plugins: plugins?.map((plugin) => {\n return {\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 () => {\n setTitleContainer(\n document.getElementById(PLUGIN_TITLE_CONTAINER_ID) ||\n null,\n )\n convertRender(\n plugin.name as PluginRender,\n setTitleComponent,\n )\n },\n render: () => {\n setPluginContainer(\n document.getElementById(PLUGIN_CONTAINER_ID) || null,\n )\n convertRender(plugin.render, setPluginComponent)\n },\n }\n }),\n }),\n )\n useEffect(() => {\n if (devToolRef.current) {\n devtools.mount(devToolRef.current)\n }\n\n return () => devtools.unmount()\n }, [devtools])\n\n return (\n <>\n <div style={{ position: 'absolute' }} ref={devToolRef} />\n {pluginContainer && PluginComponent\n ? createPortal(<>{PluginComponent}</>, pluginContainer)\n : null}\n {titleContainer && TitleComponent\n ? createPortal(<>{TitleComponent}</>, titleContainer)\n : null}\n </>\n )\n}\n"],"names":["useRef","useState","devtools","TanStackDevtoolsCore","PLUGIN_TITLE_CONTAINER_ID","PLUGIN_CONTAINER_ID","useEffect","jsxs","Fragment","jsx","createPortal"],"mappings":";;;;;;AA4FA,MAAM,gBAAgB,CACpB,WACA,iBACG;AACH,eAAa,OAAO,cAAc,aAAa,UAAA,IAAc,SAAS;AACxE;AAEO,MAAM,mBAAmB,CAAC;AAAA,EAC/B;AAAA,EACA;AAAA,EACA;AACF,MAAsD;AACpD,QAAM,aAAaA,MAAAA,OAAuB,IAAI;AAC9C,QAAM,CAAC,iBAAiB,kBAAkB,IAAIC,MAAAA;AAAAA,IAC5C;AAAA,EAAA;AAEF,QAAM,CAAC,gBAAgB,iBAAiB,IAAIA,MAAAA,SAA6B,IAAI;AAC7E,QAAM,CAAC,iBAAiB,kBAAkB,IAAIA,MAAAA;AAAAA,IAC5C;AAAA,EAAA;AAEF,QAAM,CAAC,gBAAgB,iBAAiB,IAAIA,MAAAA,SAA6B,IAAI;AAC7E,QAAM,CAACC,UAAQ,IAAID,MAAAA;AAAAA,IACjB,MACE,IAAIE,SAAAA,qBAAqB;AAAA,MACvB;AAAA,MACA;AAAA,MACA,SAAS,SAAS,IAAI,CAAC,WAAW;AAChC,eAAO;AAAA,UACL,GAAG;AAAA,UACH,MACE,OAAO,OAAO,SAAS,WACnB,OAAO;AAAA;AAAA,YAEP,MAAM;AACJ;AAAA,gBACE,SAAS,eAAeC,SAAAA,yBAAyB,KAC/C;AAAA,cAAA;AAEJ;AAAA,gBACE,OAAO;AAAA,gBACP;AAAA,cAAA;AAAA,YAEJ;AAAA;AAAA,UACN,QAAQ,MAAM;AACZ;AAAA,cACE,SAAS,eAAeC,SAAAA,mBAAmB,KAAK;AAAA,YAAA;AAElD,0BAAc,OAAO,QAAQ,kBAAkB;AAAA,UACjD;AAAA,QAAA;AAAA,MAEJ,CAAC;AAAA,IAAA,CACF;AAAA,EAAA;AAELC,QAAAA,UAAU,MAAM;AACd,QAAI,WAAW,SAAS;AACtBJ,iBAAS,MAAM,WAAW,OAAO;AAAA,IACnC;AAEA,WAAO,MAAMA,WAAS,QAAA;AAAA,EACxB,GAAG,CAACA,UAAQ,CAAC;AAEb,SACEK,2BAAAA,KAAAC,qBAAA,EACE,UAAA;AAAA,IAAAC,+BAAC,SAAI,OAAO,EAAE,UAAU,WAAA,GAAc,KAAK,YAAY;AAAA,IACtD,mBAAmB,kBAChBC,4EAAgB,UAAA,gBAAA,CAAgB,GAAK,eAAe,IACpD;AAAA,IACH,kBAAkB,iBACfA,SAAAA,mEAAgB,UAAA,eAAA,CAAe,GAAK,cAAc,IAClD;AAAA,EAAA,GACN;AAEJ;;"}
|
package/dist/cjs/devtools.d.cts
DELETED
|
@@ -1,76 +0,0 @@
|
|
|
1
|
-
import { JSX, ReactElement } from 'react';
|
|
2
|
-
import { ClientEventBusConfig, TanStackDevtoolsConfig, TanStackDevtoolsPlugin } from '@tanstack/devtools';
|
|
3
|
-
type PluginRender = JSX.Element | (() => JSX.Element);
|
|
4
|
-
export type TanStackDevtoolsReactPlugin = Omit<TanStackDevtoolsPlugin, 'render' | 'name'> & {
|
|
5
|
-
/**
|
|
6
|
-
* The render function can be a React element or a function that returns a React element.
|
|
7
|
-
* If it's a function, it will be called to render the plugin, otherwise it will be rendered directly.
|
|
8
|
-
*
|
|
9
|
-
* Example:
|
|
10
|
-
* ```jsx
|
|
11
|
-
* {
|
|
12
|
-
* render: () => <CustomPluginComponent />,
|
|
13
|
-
* }
|
|
14
|
-
* ```
|
|
15
|
-
* or
|
|
16
|
-
* ```jsx
|
|
17
|
-
* {
|
|
18
|
-
* render: <CustomPluginComponent />,
|
|
19
|
-
* }
|
|
20
|
-
* ```
|
|
21
|
-
*/
|
|
22
|
-
render: PluginRender;
|
|
23
|
-
/**
|
|
24
|
-
* Name to be displayed in the devtools UI.
|
|
25
|
-
* If a string, it will be used as the plugin name.
|
|
26
|
-
* If a function, it will be called with the mount element.
|
|
27
|
-
*
|
|
28
|
-
* Example:
|
|
29
|
-
* ```jsx
|
|
30
|
-
* {
|
|
31
|
-
* name: "Your Plugin",
|
|
32
|
-
* render: () => <CustomPluginComponent />,
|
|
33
|
-
* }
|
|
34
|
-
* ```
|
|
35
|
-
* or
|
|
36
|
-
* ```jsx
|
|
37
|
-
* {
|
|
38
|
-
* name: <h1>Your Plugin title</h1>,
|
|
39
|
-
* render: () => <CustomPluginComponent />,
|
|
40
|
-
* }
|
|
41
|
-
* ```
|
|
42
|
-
*/
|
|
43
|
-
name: string | PluginRender;
|
|
44
|
-
};
|
|
45
|
-
export interface TanStackDevtoolsReactInit {
|
|
46
|
-
/**
|
|
47
|
-
* Array of plugins to be used in the devtools.
|
|
48
|
-
* Each plugin should have a `render` function that returns a React element or a function
|
|
49
|
-
*
|
|
50
|
-
* Example:
|
|
51
|
-
* ```jsx
|
|
52
|
-
* <TanStackDevtools
|
|
53
|
-
* plugins={[
|
|
54
|
-
* {
|
|
55
|
-
* id: "your-plugin-id",
|
|
56
|
-
* name: "Your Plugin",
|
|
57
|
-
* render: <CustomPluginComponent />,
|
|
58
|
-
* }
|
|
59
|
-
* ]}
|
|
60
|
-
* />
|
|
61
|
-
* ```
|
|
62
|
-
*/
|
|
63
|
-
plugins?: Array<TanStackDevtoolsReactPlugin>;
|
|
64
|
-
/**
|
|
65
|
-
* Configuration for the devtools shell. These configuration options are used to set the
|
|
66
|
-
* initial state of the devtools when it is started for the first time. Afterwards,
|
|
67
|
-
* the settings are persisted in local storage and changed through the settings panel.
|
|
68
|
-
*/
|
|
69
|
-
config?: Partial<TanStackDevtoolsConfig>;
|
|
70
|
-
/**
|
|
71
|
-
* Configuration for the TanStack Devtools client event bus.
|
|
72
|
-
*/
|
|
73
|
-
eventBusConfig?: ClientEventBusConfig;
|
|
74
|
-
}
|
|
75
|
-
export declare const TanStackDevtools: ({ plugins, config, eventBusConfig, }: TanStackDevtoolsReactInit) => ReactElement | null;
|
|
76
|
-
export {};
|
package/dist/cjs/index.cjs
DELETED
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
"use client";
|
|
2
|
-
"use strict";
|
|
3
|
-
Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
|
|
4
|
-
const devtools = require("./devtools.cjs");
|
|
5
|
-
const TanStackDevtools = process.env.NODE_ENV !== "development" ? function() {
|
|
6
|
-
return null;
|
|
7
|
-
} : devtools.TanStackDevtools;
|
|
8
|
-
exports.TanStackDevtools = TanStackDevtools;
|
|
9
|
-
//# sourceMappingURL=index.cjs.map
|
package/dist/cjs/index.cjs.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.cjs","sources":["../../src/index.ts"],"sourcesContent":["'use client'\n\nimport * as Devtools from './devtools'\n\nexport const TanStackDevtools: (typeof Devtools)['TanStackDevtools'] =\n process.env.NODE_ENV !== 'development'\n ? function () {\n return null\n }\n : Devtools.TanStackDevtools\n\nexport type {\n TanStackDevtoolsReactPlugin,\n TanStackDevtoolsReactInit,\n} from './devtools'\n"],"names":[],"mappings":";;;;AAIO;AAGC;AACF;;"}
|
package/dist/cjs/index.d.cts
DELETED
package/dist/cjs/production.cjs
DELETED
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
"use client";
|
|
2
|
-
"use strict";
|
|
3
|
-
Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
|
|
4
|
-
const devtools = require("./devtools.cjs");
|
|
5
|
-
const TanStackDevtools = devtools.TanStackDevtools;
|
|
6
|
-
exports.TanStackDevtools = TanStackDevtools;
|
|
7
|
-
//# sourceMappingURL=production.cjs.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"production.cjs","sources":["../../src/production.ts"],"sourcesContent":["'use client'\n\nimport * as Devtools from './devtools'\n\nexport const TanStackDevtools = Devtools.TanStackDevtools\n\nexport type {\n TanStackDevtoolsReactPlugin,\n TanStackDevtoolsReactInit,\n} from './devtools'\n"],"names":[],"mappings":";;;;AAIO;;"}
|
|
@@ -1,3 +0,0 @@
|
|
|
1
|
-
import * as Devtools from './devtools.cjs';
|
|
2
|
-
export declare const TanStackDevtools: ({ plugins, config, eventBusConfig, }: Devtools.TanStackDevtoolsReactInit) => import('react').ReactElement | null;
|
|
3
|
-
export type { TanStackDevtoolsReactPlugin, TanStackDevtoolsReactInit, } from './devtools.cjs';
|