@tanstack/react-router-devtools 1.121.15 → 1.121.17

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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@tanstack/react-router-devtools",
3
- "version": "1.121.15",
3
+ "version": "1.121.17",
4
4
  "description": "Modern and scalable routing for React applications",
5
5
  "author": "Tanner Linsley",
6
6
  "license": "MIT",
@@ -49,7 +49,7 @@
49
49
  "node": ">=12"
50
50
  },
51
51
  "dependencies": {
52
- "@tanstack/router-devtools-core": "^1.121.15"
52
+ "@tanstack/router-devtools-core": "^1.121.17"
53
53
  },
54
54
  "devDependencies": {
55
55
  "@vitejs/plugin-react": "^4.3.4",
@@ -59,7 +59,7 @@
59
59
  "peerDependencies": {
60
60
  "react": ">=18.0.0 || >=19.0.0",
61
61
  "react-dom": ">=18.0.0 || >=19.0.0",
62
- "@tanstack/react-router": "^1.121.15"
62
+ "@tanstack/react-router": "^1.121.17"
63
63
  },
64
64
  "scripts": {}
65
65
  }
@@ -1,72 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
3
- const jsxRuntime = require("react/jsx-runtime");
4
- const routerDevtoolsCore = require("@tanstack/router-devtools-core");
5
- const react = require("react");
6
- const reactRouter = require("@tanstack/react-router");
7
- function TanStackRouterDevtools(props) {
8
- const {
9
- initialIsOpen,
10
- panelProps,
11
- closeButtonProps,
12
- toggleButtonProps,
13
- position,
14
- containerElement,
15
- shadowDOMTarget,
16
- router: propsRouter
17
- } = props;
18
- const hookRouter = reactRouter.useRouter({ warn: false });
19
- const activeRouter = propsRouter ?? hookRouter;
20
- const activeRouterState = reactRouter.useRouterState({ router: activeRouter });
21
- const devToolRef = react.useRef(null);
22
- const [devtools] = react.useState(
23
- () => new routerDevtoolsCore.TanStackRouterDevtoolsCore({
24
- initialIsOpen,
25
- panelProps,
26
- closeButtonProps,
27
- toggleButtonProps,
28
- position,
29
- containerElement,
30
- shadowDOMTarget,
31
- router: activeRouter,
32
- routerState: activeRouterState
33
- })
34
- );
35
- react.useEffect(() => {
36
- devtools.setRouter(activeRouter);
37
- }, [devtools, activeRouter]);
38
- react.useEffect(() => {
39
- devtools.setRouterState(activeRouterState);
40
- }, [devtools, activeRouterState]);
41
- react.useEffect(() => {
42
- devtools.setOptions({
43
- initialIsOpen,
44
- panelProps,
45
- closeButtonProps,
46
- toggleButtonProps,
47
- position,
48
- containerElement,
49
- shadowDOMTarget
50
- });
51
- }, [
52
- devtools,
53
- initialIsOpen,
54
- panelProps,
55
- closeButtonProps,
56
- toggleButtonProps,
57
- position,
58
- containerElement,
59
- shadowDOMTarget
60
- ]);
61
- react.useEffect(() => {
62
- if (devToolRef.current) {
63
- devtools.mount(devToolRef.current);
64
- }
65
- return () => {
66
- devtools.unmount();
67
- };
68
- }, [devtools]);
69
- return /* @__PURE__ */ jsxRuntime.jsx(react.Fragment, { children: /* @__PURE__ */ jsxRuntime.jsx("div", { ref: devToolRef }) });
70
- }
71
- exports.TanStackRouterDevtools = TanStackRouterDevtools;
72
- //# sourceMappingURL=TanStackRouterDevtools.cjs.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"TanStackRouterDevtools.cjs","sources":["../../src/TanStackRouterDevtools.tsx"],"sourcesContent":["import { TanStackRouterDevtoolsCore } from '@tanstack/router-devtools-core'\nimport { Fragment, useEffect, useRef, useState } from 'react'\nimport { useRouter, useRouterState } from '@tanstack/react-router'\nimport type { ButtonHTMLAttributes, HTMLAttributes } from 'react'\nimport type { AnyRouter } from '@tanstack/react-router'\nimport type React from 'react'\n\ninterface DevtoolsOptions {\n /**\n * Set this true if you want the dev tools to default to being open\n */\n initialIsOpen?: boolean\n /**\n * Use this to add props to the panel. For example, you can add className, style (merge and override default style), etc.\n */\n panelProps?: HTMLAttributes<HTMLDivElement>\n /**\n * Use this to add props to the close button. For example, you can add className, style (merge and override default style), onClick (extend default handler), etc.\n */\n closeButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>\n /**\n * Use this to add props to the toggle button. For example, you can add className, style (merge and override default style), onClick (extend default handler), etc.\n */\n toggleButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>\n /**\n * The position of the TanStack Router logo to open and close the devtools panel.\n * Defaults to 'bottom-left'.\n */\n position?: 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'\n /**\n * Use this to render the devtools inside a different type of container element for a11y purposes.\n * Any string which corresponds to a valid intrinsic JSX element is allowed.\n * Defaults to 'footer'.\n */\n containerElement?: string | any\n /**\n * The router instance to use for the devtools.\n */\n router?: AnyRouter\n /**\n * Use this to attach the devtool's styles to specific element in the DOM.\n */\n shadowDOMTarget?: ShadowRoot\n}\n\nexport function TanStackRouterDevtools(\n props: DevtoolsOptions,\n): React.ReactElement | null {\n const {\n initialIsOpen,\n panelProps,\n closeButtonProps,\n toggleButtonProps,\n position,\n containerElement,\n shadowDOMTarget,\n router: propsRouter,\n } = props\n\n const hookRouter = useRouter({ warn: false })\n const activeRouter = propsRouter ?? hookRouter\n\n const activeRouterState = useRouterState({ router: activeRouter })\n\n const devToolRef = useRef<HTMLDivElement>(null)\n const [devtools] = useState(\n () =>\n new TanStackRouterDevtoolsCore({\n initialIsOpen,\n panelProps,\n closeButtonProps,\n toggleButtonProps,\n position,\n containerElement,\n shadowDOMTarget,\n router: activeRouter,\n routerState: activeRouterState,\n }),\n )\n\n // Update devtools when props change\n useEffect(() => {\n devtools.setRouter(activeRouter)\n }, [devtools, activeRouter])\n\n useEffect(() => {\n devtools.setRouterState(activeRouterState)\n }, [devtools, activeRouterState])\n\n useEffect(() => {\n devtools.setOptions({\n initialIsOpen: initialIsOpen,\n panelProps: panelProps,\n closeButtonProps: closeButtonProps,\n toggleButtonProps: toggleButtonProps,\n position: position,\n containerElement: containerElement,\n shadowDOMTarget: shadowDOMTarget,\n })\n }, [\n devtools,\n initialIsOpen,\n panelProps,\n closeButtonProps,\n toggleButtonProps,\n position,\n containerElement,\n shadowDOMTarget,\n ])\n\n useEffect(() => {\n if (devToolRef.current) {\n devtools.mount(devToolRef.current)\n }\n\n return () => {\n devtools.unmount()\n }\n }, [devtools])\n\n return (\n <Fragment>\n <div ref={devToolRef} />\n </Fragment>\n )\n}\n"],"names":["useRouter","useRouterState","useRef","useState","TanStackRouterDevtoolsCore","useEffect","Fragment","jsx"],"mappings":";;;;;;AA6CO,SAAS,uBACd,OAC2B;AACrB,QAAA;AAAA,IACJ;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,QAAQ;AAAA,EAAA,IACN;AAEJ,QAAM,aAAaA,YAAA,UAAU,EAAE,MAAM,OAAO;AAC5C,QAAM,eAAe,eAAe;AAEpC,QAAM,oBAAoBC,YAAA,eAAe,EAAE,QAAQ,cAAc;AAE3D,QAAA,aAAaC,aAAuB,IAAI;AACxC,QAAA,CAAC,QAAQ,IAAIC,MAAA;AAAA,IACjB,MACE,IAAIC,mBAAAA,2BAA2B;AAAA,MAC7B;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA,QAAQ;AAAA,MACR,aAAa;AAAA,IACd,CAAA;AAAA,EACL;AAGAC,QAAAA,UAAU,MAAM;AACd,aAAS,UAAU,YAAY;AAAA,EAAA,GAC9B,CAAC,UAAU,YAAY,CAAC;AAE3BA,QAAAA,UAAU,MAAM;AACd,aAAS,eAAe,iBAAiB;AAAA,EAAA,GACxC,CAAC,UAAU,iBAAiB,CAAC;AAEhCA,QAAAA,UAAU,MAAM;AACd,aAAS,WAAW;AAAA,MAClB;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IAAA,CACD;AAAA,EAAA,GACA;AAAA,IACD;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EAAA,CACD;AAEDA,QAAAA,UAAU,MAAM;AACd,QAAI,WAAW,SAAS;AACb,eAAA,MAAM,WAAW,OAAO;AAAA,IAAA;AAGnC,WAAO,MAAM;AACX,eAAS,QAAQ;AAAA,IACnB;AAAA,EAAA,GACC,CAAC,QAAQ,CAAC;AAEb,wCACGC,gBACC,EAAA,UAAAC,2BAAAA,IAAC,OAAI,EAAA,KAAK,WAAY,CAAA,GACxB;AAEJ;;"}
@@ -1,41 +0,0 @@
1
- import { ButtonHTMLAttributes, HTMLAttributes, default as React } from 'react';
2
- import { AnyRouter } from '@tanstack/react-router';
3
- interface DevtoolsOptions {
4
- /**
5
- * Set this true if you want the dev tools to default to being open
6
- */
7
- initialIsOpen?: boolean;
8
- /**
9
- * Use this to add props to the panel. For example, you can add className, style (merge and override default style), etc.
10
- */
11
- panelProps?: HTMLAttributes<HTMLDivElement>;
12
- /**
13
- * Use this to add props to the close button. For example, you can add className, style (merge and override default style), onClick (extend default handler), etc.
14
- */
15
- closeButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>;
16
- /**
17
- * Use this to add props to the toggle button. For example, you can add className, style (merge and override default style), onClick (extend default handler), etc.
18
- */
19
- toggleButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>;
20
- /**
21
- * The position of the TanStack Router logo to open and close the devtools panel.
22
- * Defaults to 'bottom-left'.
23
- */
24
- position?: 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
25
- /**
26
- * Use this to render the devtools inside a different type of container element for a11y purposes.
27
- * Any string which corresponds to a valid intrinsic JSX element is allowed.
28
- * Defaults to 'footer'.
29
- */
30
- containerElement?: string | any;
31
- /**
32
- * The router instance to use for the devtools.
33
- */
34
- router?: AnyRouter;
35
- /**
36
- * Use this to attach the devtool's styles to specific element in the DOM.
37
- */
38
- shadowDOMTarget?: ShadowRoot;
39
- }
40
- export declare function TanStackRouterDevtools(props: DevtoolsOptions): React.ReactElement | null;
41
- export {};
@@ -1,44 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
3
- const jsxRuntime = require("react/jsx-runtime");
4
- const reactRouter = require("@tanstack/react-router");
5
- const routerDevtoolsCore = require("@tanstack/router-devtools-core");
6
- const react = require("react");
7
- const TanStackRouterDevtoolsPanel = (props) => {
8
- const { router: propsRouter, ...rest } = props;
9
- const hookRouter = reactRouter.useRouter({ warn: false });
10
- const activeRouter = propsRouter ?? hookRouter;
11
- const activeRouterState = reactRouter.useRouterState({ router: activeRouter });
12
- const devToolRef = react.useRef(null);
13
- const [devtools] = react.useState(
14
- () => new routerDevtoolsCore.TanStackRouterDevtoolsPanelCore({
15
- ...rest,
16
- router: activeRouter,
17
- routerState: activeRouterState
18
- })
19
- );
20
- react.useEffect(() => {
21
- devtools.setRouter(activeRouter);
22
- }, [devtools, activeRouter]);
23
- react.useEffect(() => {
24
- devtools.setRouterState(activeRouterState);
25
- }, [devtools, activeRouterState]);
26
- react.useEffect(() => {
27
- devtools.setOptions({
28
- className: props.className,
29
- style: props.style,
30
- shadowDOMTarget: props.shadowDOMTarget
31
- });
32
- }, [devtools, props.className, props.style, props.shadowDOMTarget]);
33
- react.useEffect(() => {
34
- if (devToolRef.current) {
35
- devtools.mount(devToolRef.current);
36
- }
37
- return () => {
38
- devtools.unmount();
39
- };
40
- }, [devtools]);
41
- return /* @__PURE__ */ jsxRuntime.jsx(jsxRuntime.Fragment, { children: /* @__PURE__ */ jsxRuntime.jsx("div", { ref: devToolRef }) });
42
- };
43
- exports.TanStackRouterDevtoolsPanel = TanStackRouterDevtoolsPanel;
44
- //# sourceMappingURL=TanStackRouterDevtoolsPanel.cjs.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"TanStackRouterDevtoolsPanel.cjs","sources":["../../src/TanStackRouterDevtoolsPanel.tsx"],"sourcesContent":["import { useRouter, useRouterState } from '@tanstack/react-router'\nimport { TanStackRouterDevtoolsPanelCore } from '@tanstack/router-devtools-core'\nimport React, { useEffect, useRef, useState } from 'react'\nimport type { AnyRouter } from '@tanstack/react-router'\n\nexport interface DevtoolsPanelOptions {\n /**\n * The standard React style object used to style a component with inline styles\n */\n style?: any\n /**\n * The standard React class property used to style a component with classes\n */\n className?: string\n /**\n * A boolean variable indicating whether the panel is open or closed\n */\n isOpen?: boolean\n /**\n * A function that toggles the open and close state of the panel\n */\n setIsOpen?: (isOpen: boolean) => void\n /**\n * Handles the opening and closing the devtools panel\n */\n handleDragStart?: (e: any) => void\n /**\n * A boolean variable indicating if the \"lite\" version of the library is being used\n */\n router?: AnyRouter\n /**\n * Use this to attach the devtool's styles to specific element in the DOM.\n */\n shadowDOMTarget?: ShadowRoot\n}\n\nexport const TanStackRouterDevtoolsPanel: React.FC<DevtoolsPanelOptions> = (\n props,\n): React.ReactElement | null => {\n const { router: propsRouter, ...rest } = props\n const hookRouter = useRouter({ warn: false })\n const activeRouter = propsRouter ?? hookRouter\n const activeRouterState = useRouterState({ router: activeRouter })\n\n const devToolRef = useRef<HTMLDivElement>(null)\n const [devtools] = useState(\n () =>\n new TanStackRouterDevtoolsPanelCore({\n ...rest,\n router: activeRouter,\n routerState: activeRouterState,\n }),\n )\n\n // Update devtools when props change\n useEffect(() => {\n devtools.setRouter(activeRouter)\n }, [devtools, activeRouter])\n\n useEffect(() => {\n devtools.setRouterState(activeRouterState)\n }, [devtools, activeRouterState])\n\n useEffect(() => {\n devtools.setOptions({\n className: props.className,\n style: props.style,\n shadowDOMTarget: props.shadowDOMTarget,\n })\n }, [devtools, props.className, props.style, props.shadowDOMTarget])\n\n useEffect(() => {\n if (devToolRef.current) {\n devtools.mount(devToolRef.current)\n }\n\n return () => {\n devtools.unmount()\n }\n }, [devtools])\n\n return (\n <>\n <div ref={devToolRef} />\n </>\n )\n}\n"],"names":["useRouter","useRouterState","useRef","useState","TanStackRouterDevtoolsPanelCore","useEffect","jsx","Fragment"],"mappings":";;;;;;AAoCa,MAAA,8BAA8D,CACzE,UAC8B;AAC9B,QAAM,EAAE,QAAQ,aAAa,GAAG,KAAS,IAAA;AACzC,QAAM,aAAaA,YAAA,UAAU,EAAE,MAAM,OAAO;AAC5C,QAAM,eAAe,eAAe;AACpC,QAAM,oBAAoBC,YAAA,eAAe,EAAE,QAAQ,cAAc;AAE3D,QAAA,aAAaC,aAAuB,IAAI;AACxC,QAAA,CAAC,QAAQ,IAAIC,MAAA;AAAA,IACjB,MACE,IAAIC,mBAAAA,gCAAgC;AAAA,MAClC,GAAG;AAAA,MACH,QAAQ;AAAA,MACR,aAAa;AAAA,IACd,CAAA;AAAA,EACL;AAGAC,QAAAA,UAAU,MAAM;AACd,aAAS,UAAU,YAAY;AAAA,EAAA,GAC9B,CAAC,UAAU,YAAY,CAAC;AAE3BA,QAAAA,UAAU,MAAM;AACd,aAAS,eAAe,iBAAiB;AAAA,EAAA,GACxC,CAAC,UAAU,iBAAiB,CAAC;AAEhCA,QAAAA,UAAU,MAAM;AACd,aAAS,WAAW;AAAA,MAClB,WAAW,MAAM;AAAA,MACjB,OAAO,MAAM;AAAA,MACb,iBAAiB,MAAM;AAAA,IAAA,CACxB;AAAA,EAAA,GACA,CAAC,UAAU,MAAM,WAAW,MAAM,OAAO,MAAM,eAAe,CAAC;AAElEA,QAAAA,UAAU,MAAM;AACd,QAAI,WAAW,SAAS;AACb,eAAA,MAAM,WAAW,OAAO;AAAA,IAAA;AAGnC,WAAO,MAAM;AACX,eAAS,QAAQ;AAAA,IACnB;AAAA,EAAA,GACC,CAAC,QAAQ,CAAC;AAEb,SAEIC,2BAAA,IAAAC,qBAAA,EAAA,UAAAD,2BAAAA,IAAC,OAAI,EAAA,KAAK,WAAY,CAAA,GACxB;AAEJ;;"}
@@ -1,33 +0,0 @@
1
- import { default as React } from 'react';
2
- import { AnyRouter } from '@tanstack/react-router';
3
- export interface DevtoolsPanelOptions {
4
- /**
5
- * The standard React style object used to style a component with inline styles
6
- */
7
- style?: any;
8
- /**
9
- * The standard React class property used to style a component with classes
10
- */
11
- className?: string;
12
- /**
13
- * A boolean variable indicating whether the panel is open or closed
14
- */
15
- isOpen?: boolean;
16
- /**
17
- * A function that toggles the open and close state of the panel
18
- */
19
- setIsOpen?: (isOpen: boolean) => void;
20
- /**
21
- * Handles the opening and closing the devtools panel
22
- */
23
- handleDragStart?: (e: any) => void;
24
- /**
25
- * A boolean variable indicating if the "lite" version of the library is being used
26
- */
27
- router?: AnyRouter;
28
- /**
29
- * Use this to attach the devtool's styles to specific element in the DOM.
30
- */
31
- shadowDOMTarget?: ShadowRoot;
32
- }
33
- export declare const TanStackRouterDevtoolsPanel: React.FC<DevtoolsPanelOptions>;
@@ -1,17 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
3
- const TanStackRouterDevtools$1 = require("./TanStackRouterDevtools.cjs");
4
- const TanStackRouterDevtoolsPanel$1 = require("./TanStackRouterDevtoolsPanel.cjs");
5
- const TanStackRouterDevtools = process.env.NODE_ENV !== "development" ? function() {
6
- return null;
7
- } : TanStackRouterDevtools$1.TanStackRouterDevtools;
8
- const TanStackRouterDevtoolsInProd = TanStackRouterDevtools$1.TanStackRouterDevtools;
9
- const TanStackRouterDevtoolsPanel = process.env.NODE_ENV !== "development" ? function() {
10
- return null;
11
- } : TanStackRouterDevtoolsPanel$1.TanStackRouterDevtoolsPanel;
12
- const TanStackRouterDevtoolsPanelInProd = TanStackRouterDevtoolsPanel$1.TanStackRouterDevtoolsPanel;
13
- exports.TanStackRouterDevtools = TanStackRouterDevtools;
14
- exports.TanStackRouterDevtoolsInProd = TanStackRouterDevtoolsInProd;
15
- exports.TanStackRouterDevtoolsPanel = TanStackRouterDevtoolsPanel;
16
- exports.TanStackRouterDevtoolsPanelInProd = TanStackRouterDevtoolsPanelInProd;
17
- //# sourceMappingURL=index.cjs.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.cjs","sources":["../../src/index.ts"],"sourcesContent":["import * as Devtools from './TanStackRouterDevtools'\nimport * as DevtoolsPanel from './TanStackRouterDevtoolsPanel'\n\nexport const TanStackRouterDevtools: (typeof Devtools)['TanStackRouterDevtools'] =\n process.env.NODE_ENV !== 'development'\n ? function () {\n return null\n }\n : Devtools.TanStackRouterDevtools\n\nexport const TanStackRouterDevtoolsInProd: (typeof Devtools)['TanStackRouterDevtools'] =\n Devtools.TanStackRouterDevtools\n\nexport const TanStackRouterDevtoolsPanel: (typeof DevtoolsPanel)['TanStackRouterDevtoolsPanel'] =\n process.env.NODE_ENV !== 'development'\n ? function () {\n return null\n }\n : DevtoolsPanel.TanStackRouterDevtoolsPanel\n\nexport const TanStackRouterDevtoolsPanelInProd: (typeof DevtoolsPanel)['TanStackRouterDevtoolsPanel'] =\n DevtoolsPanel.TanStackRouterDevtoolsPanel\n"],"names":["Devtools.TanStackRouterDevtools","DevtoolsPanel.TanStackRouterDevtoolsPanel"],"mappings":";;;;AAGO,MAAM,yBACX,QAAQ,IAAI,aAAa,gBACrB,WAAY;AACH,SAAA;AACT,IACAA,yBAAAA;AAEC,MAAM,+BACXA,yBAAAA;AAEK,MAAM,8BACX,QAAQ,IAAI,aAAa,gBACrB,WAAY;AACH,SAAA;AACT,IACAC,8BAAAA;AAEC,MAAM,oCACXA,8BAAAA;;;;;"}
@@ -1,6 +0,0 @@
1
- import * as Devtools from './TanStackRouterDevtools.cjs';
2
- import * as DevtoolsPanel from './TanStackRouterDevtoolsPanel.cjs';
3
- export declare const TanStackRouterDevtools: (typeof Devtools)['TanStackRouterDevtools'];
4
- export declare const TanStackRouterDevtoolsInProd: (typeof Devtools)['TanStackRouterDevtools'];
5
- export declare const TanStackRouterDevtoolsPanel: (typeof DevtoolsPanel)['TanStackRouterDevtoolsPanel'];
6
- export declare const TanStackRouterDevtoolsPanelInProd: (typeof DevtoolsPanel)['TanStackRouterDevtoolsPanel'];
@@ -1,41 +0,0 @@
1
- import { ButtonHTMLAttributes, HTMLAttributes, default as React } from 'react';
2
- import { AnyRouter } from '@tanstack/react-router';
3
- interface DevtoolsOptions {
4
- /**
5
- * Set this true if you want the dev tools to default to being open
6
- */
7
- initialIsOpen?: boolean;
8
- /**
9
- * Use this to add props to the panel. For example, you can add className, style (merge and override default style), etc.
10
- */
11
- panelProps?: HTMLAttributes<HTMLDivElement>;
12
- /**
13
- * Use this to add props to the close button. For example, you can add className, style (merge and override default style), onClick (extend default handler), etc.
14
- */
15
- closeButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>;
16
- /**
17
- * Use this to add props to the toggle button. For example, you can add className, style (merge and override default style), onClick (extend default handler), etc.
18
- */
19
- toggleButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>;
20
- /**
21
- * The position of the TanStack Router logo to open and close the devtools panel.
22
- * Defaults to 'bottom-left'.
23
- */
24
- position?: 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
25
- /**
26
- * Use this to render the devtools inside a different type of container element for a11y purposes.
27
- * Any string which corresponds to a valid intrinsic JSX element is allowed.
28
- * Defaults to 'footer'.
29
- */
30
- containerElement?: string | any;
31
- /**
32
- * The router instance to use for the devtools.
33
- */
34
- router?: AnyRouter;
35
- /**
36
- * Use this to attach the devtool's styles to specific element in the DOM.
37
- */
38
- shadowDOMTarget?: ShadowRoot;
39
- }
40
- export declare function TanStackRouterDevtools(props: DevtoolsOptions): React.ReactElement | null;
41
- export {};
@@ -1,72 +0,0 @@
1
- import { jsx } from "react/jsx-runtime";
2
- import { TanStackRouterDevtoolsCore } from "@tanstack/router-devtools-core";
3
- import { useRef, useState, useEffect, Fragment } from "react";
4
- import { useRouter, useRouterState } from "@tanstack/react-router";
5
- function TanStackRouterDevtools(props) {
6
- const {
7
- initialIsOpen,
8
- panelProps,
9
- closeButtonProps,
10
- toggleButtonProps,
11
- position,
12
- containerElement,
13
- shadowDOMTarget,
14
- router: propsRouter
15
- } = props;
16
- const hookRouter = useRouter({ warn: false });
17
- const activeRouter = propsRouter ?? hookRouter;
18
- const activeRouterState = useRouterState({ router: activeRouter });
19
- const devToolRef = useRef(null);
20
- const [devtools] = useState(
21
- () => new TanStackRouterDevtoolsCore({
22
- initialIsOpen,
23
- panelProps,
24
- closeButtonProps,
25
- toggleButtonProps,
26
- position,
27
- containerElement,
28
- shadowDOMTarget,
29
- router: activeRouter,
30
- routerState: activeRouterState
31
- })
32
- );
33
- useEffect(() => {
34
- devtools.setRouter(activeRouter);
35
- }, [devtools, activeRouter]);
36
- useEffect(() => {
37
- devtools.setRouterState(activeRouterState);
38
- }, [devtools, activeRouterState]);
39
- useEffect(() => {
40
- devtools.setOptions({
41
- initialIsOpen,
42
- panelProps,
43
- closeButtonProps,
44
- toggleButtonProps,
45
- position,
46
- containerElement,
47
- shadowDOMTarget
48
- });
49
- }, [
50
- devtools,
51
- initialIsOpen,
52
- panelProps,
53
- closeButtonProps,
54
- toggleButtonProps,
55
- position,
56
- containerElement,
57
- shadowDOMTarget
58
- ]);
59
- useEffect(() => {
60
- if (devToolRef.current) {
61
- devtools.mount(devToolRef.current);
62
- }
63
- return () => {
64
- devtools.unmount();
65
- };
66
- }, [devtools]);
67
- return /* @__PURE__ */ jsx(Fragment, { children: /* @__PURE__ */ jsx("div", { ref: devToolRef }) });
68
- }
69
- export {
70
- TanStackRouterDevtools
71
- };
72
- //# sourceMappingURL=TanStackRouterDevtools.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"TanStackRouterDevtools.js","sources":["../../src/TanStackRouterDevtools.tsx"],"sourcesContent":["import { TanStackRouterDevtoolsCore } from '@tanstack/router-devtools-core'\nimport { Fragment, useEffect, useRef, useState } from 'react'\nimport { useRouter, useRouterState } from '@tanstack/react-router'\nimport type { ButtonHTMLAttributes, HTMLAttributes } from 'react'\nimport type { AnyRouter } from '@tanstack/react-router'\nimport type React from 'react'\n\ninterface DevtoolsOptions {\n /**\n * Set this true if you want the dev tools to default to being open\n */\n initialIsOpen?: boolean\n /**\n * Use this to add props to the panel. For example, you can add className, style (merge and override default style), etc.\n */\n panelProps?: HTMLAttributes<HTMLDivElement>\n /**\n * Use this to add props to the close button. For example, you can add className, style (merge and override default style), onClick (extend default handler), etc.\n */\n closeButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>\n /**\n * Use this to add props to the toggle button. For example, you can add className, style (merge and override default style), onClick (extend default handler), etc.\n */\n toggleButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>\n /**\n * The position of the TanStack Router logo to open and close the devtools panel.\n * Defaults to 'bottom-left'.\n */\n position?: 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'\n /**\n * Use this to render the devtools inside a different type of container element for a11y purposes.\n * Any string which corresponds to a valid intrinsic JSX element is allowed.\n * Defaults to 'footer'.\n */\n containerElement?: string | any\n /**\n * The router instance to use for the devtools.\n */\n router?: AnyRouter\n /**\n * Use this to attach the devtool's styles to specific element in the DOM.\n */\n shadowDOMTarget?: ShadowRoot\n}\n\nexport function TanStackRouterDevtools(\n props: DevtoolsOptions,\n): React.ReactElement | null {\n const {\n initialIsOpen,\n panelProps,\n closeButtonProps,\n toggleButtonProps,\n position,\n containerElement,\n shadowDOMTarget,\n router: propsRouter,\n } = props\n\n const hookRouter = useRouter({ warn: false })\n const activeRouter = propsRouter ?? hookRouter\n\n const activeRouterState = useRouterState({ router: activeRouter })\n\n const devToolRef = useRef<HTMLDivElement>(null)\n const [devtools] = useState(\n () =>\n new TanStackRouterDevtoolsCore({\n initialIsOpen,\n panelProps,\n closeButtonProps,\n toggleButtonProps,\n position,\n containerElement,\n shadowDOMTarget,\n router: activeRouter,\n routerState: activeRouterState,\n }),\n )\n\n // Update devtools when props change\n useEffect(() => {\n devtools.setRouter(activeRouter)\n }, [devtools, activeRouter])\n\n useEffect(() => {\n devtools.setRouterState(activeRouterState)\n }, [devtools, activeRouterState])\n\n useEffect(() => {\n devtools.setOptions({\n initialIsOpen: initialIsOpen,\n panelProps: panelProps,\n closeButtonProps: closeButtonProps,\n toggleButtonProps: toggleButtonProps,\n position: position,\n containerElement: containerElement,\n shadowDOMTarget: shadowDOMTarget,\n })\n }, [\n devtools,\n initialIsOpen,\n panelProps,\n closeButtonProps,\n toggleButtonProps,\n position,\n containerElement,\n shadowDOMTarget,\n ])\n\n useEffect(() => {\n if (devToolRef.current) {\n devtools.mount(devToolRef.current)\n }\n\n return () => {\n devtools.unmount()\n }\n }, [devtools])\n\n return (\n <Fragment>\n <div ref={devToolRef} />\n </Fragment>\n )\n}\n"],"names":[],"mappings":";;;;AA6CO,SAAS,uBACd,OAC2B;AACrB,QAAA;AAAA,IACJ;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,QAAQ;AAAA,EAAA,IACN;AAEJ,QAAM,aAAa,UAAU,EAAE,MAAM,OAAO;AAC5C,QAAM,eAAe,eAAe;AAEpC,QAAM,oBAAoB,eAAe,EAAE,QAAQ,cAAc;AAE3D,QAAA,aAAa,OAAuB,IAAI;AACxC,QAAA,CAAC,QAAQ,IAAI;AAAA,IACjB,MACE,IAAI,2BAA2B;AAAA,MAC7B;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA,QAAQ;AAAA,MACR,aAAa;AAAA,IACd,CAAA;AAAA,EACL;AAGA,YAAU,MAAM;AACd,aAAS,UAAU,YAAY;AAAA,EAAA,GAC9B,CAAC,UAAU,YAAY,CAAC;AAE3B,YAAU,MAAM;AACd,aAAS,eAAe,iBAAiB;AAAA,EAAA,GACxC,CAAC,UAAU,iBAAiB,CAAC;AAEhC,YAAU,MAAM;AACd,aAAS,WAAW;AAAA,MAClB;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IAAA,CACD;AAAA,EAAA,GACA;AAAA,IACD;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EAAA,CACD;AAED,YAAU,MAAM;AACd,QAAI,WAAW,SAAS;AACb,eAAA,MAAM,WAAW,OAAO;AAAA,IAAA;AAGnC,WAAO,MAAM;AACX,eAAS,QAAQ;AAAA,IACnB;AAAA,EAAA,GACC,CAAC,QAAQ,CAAC;AAEb,6BACG,UACC,EAAA,UAAA,oBAAC,OAAI,EAAA,KAAK,WAAY,CAAA,GACxB;AAEJ;"}
@@ -1,33 +0,0 @@
1
- import { default as React } from 'react';
2
- import { AnyRouter } from '@tanstack/react-router';
3
- export interface DevtoolsPanelOptions {
4
- /**
5
- * The standard React style object used to style a component with inline styles
6
- */
7
- style?: any;
8
- /**
9
- * The standard React class property used to style a component with classes
10
- */
11
- className?: string;
12
- /**
13
- * A boolean variable indicating whether the panel is open or closed
14
- */
15
- isOpen?: boolean;
16
- /**
17
- * A function that toggles the open and close state of the panel
18
- */
19
- setIsOpen?: (isOpen: boolean) => void;
20
- /**
21
- * Handles the opening and closing the devtools panel
22
- */
23
- handleDragStart?: (e: any) => void;
24
- /**
25
- * A boolean variable indicating if the "lite" version of the library is being used
26
- */
27
- router?: AnyRouter;
28
- /**
29
- * Use this to attach the devtool's styles to specific element in the DOM.
30
- */
31
- shadowDOMTarget?: ShadowRoot;
32
- }
33
- export declare const TanStackRouterDevtoolsPanel: React.FC<DevtoolsPanelOptions>;
@@ -1,44 +0,0 @@
1
- import { jsx, Fragment } from "react/jsx-runtime";
2
- import { useRouter, useRouterState } from "@tanstack/react-router";
3
- import { TanStackRouterDevtoolsPanelCore } from "@tanstack/router-devtools-core";
4
- import { useRef, useState, useEffect } from "react";
5
- const TanStackRouterDevtoolsPanel = (props) => {
6
- const { router: propsRouter, ...rest } = props;
7
- const hookRouter = useRouter({ warn: false });
8
- const activeRouter = propsRouter ?? hookRouter;
9
- const activeRouterState = useRouterState({ router: activeRouter });
10
- const devToolRef = useRef(null);
11
- const [devtools] = useState(
12
- () => new TanStackRouterDevtoolsPanelCore({
13
- ...rest,
14
- router: activeRouter,
15
- routerState: activeRouterState
16
- })
17
- );
18
- useEffect(() => {
19
- devtools.setRouter(activeRouter);
20
- }, [devtools, activeRouter]);
21
- useEffect(() => {
22
- devtools.setRouterState(activeRouterState);
23
- }, [devtools, activeRouterState]);
24
- useEffect(() => {
25
- devtools.setOptions({
26
- className: props.className,
27
- style: props.style,
28
- shadowDOMTarget: props.shadowDOMTarget
29
- });
30
- }, [devtools, props.className, props.style, props.shadowDOMTarget]);
31
- useEffect(() => {
32
- if (devToolRef.current) {
33
- devtools.mount(devToolRef.current);
34
- }
35
- return () => {
36
- devtools.unmount();
37
- };
38
- }, [devtools]);
39
- return /* @__PURE__ */ jsx(Fragment, { children: /* @__PURE__ */ jsx("div", { ref: devToolRef }) });
40
- };
41
- export {
42
- TanStackRouterDevtoolsPanel
43
- };
44
- //# sourceMappingURL=TanStackRouterDevtoolsPanel.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"TanStackRouterDevtoolsPanel.js","sources":["../../src/TanStackRouterDevtoolsPanel.tsx"],"sourcesContent":["import { useRouter, useRouterState } from '@tanstack/react-router'\nimport { TanStackRouterDevtoolsPanelCore } from '@tanstack/router-devtools-core'\nimport React, { useEffect, useRef, useState } from 'react'\nimport type { AnyRouter } from '@tanstack/react-router'\n\nexport interface DevtoolsPanelOptions {\n /**\n * The standard React style object used to style a component with inline styles\n */\n style?: any\n /**\n * The standard React class property used to style a component with classes\n */\n className?: string\n /**\n * A boolean variable indicating whether the panel is open or closed\n */\n isOpen?: boolean\n /**\n * A function that toggles the open and close state of the panel\n */\n setIsOpen?: (isOpen: boolean) => void\n /**\n * Handles the opening and closing the devtools panel\n */\n handleDragStart?: (e: any) => void\n /**\n * A boolean variable indicating if the \"lite\" version of the library is being used\n */\n router?: AnyRouter\n /**\n * Use this to attach the devtool's styles to specific element in the DOM.\n */\n shadowDOMTarget?: ShadowRoot\n}\n\nexport const TanStackRouterDevtoolsPanel: React.FC<DevtoolsPanelOptions> = (\n props,\n): React.ReactElement | null => {\n const { router: propsRouter, ...rest } = props\n const hookRouter = useRouter({ warn: false })\n const activeRouter = propsRouter ?? hookRouter\n const activeRouterState = useRouterState({ router: activeRouter })\n\n const devToolRef = useRef<HTMLDivElement>(null)\n const [devtools] = useState(\n () =>\n new TanStackRouterDevtoolsPanelCore({\n ...rest,\n router: activeRouter,\n routerState: activeRouterState,\n }),\n )\n\n // Update devtools when props change\n useEffect(() => {\n devtools.setRouter(activeRouter)\n }, [devtools, activeRouter])\n\n useEffect(() => {\n devtools.setRouterState(activeRouterState)\n }, [devtools, activeRouterState])\n\n useEffect(() => {\n devtools.setOptions({\n className: props.className,\n style: props.style,\n shadowDOMTarget: props.shadowDOMTarget,\n })\n }, [devtools, props.className, props.style, props.shadowDOMTarget])\n\n useEffect(() => {\n if (devToolRef.current) {\n devtools.mount(devToolRef.current)\n }\n\n return () => {\n devtools.unmount()\n }\n }, [devtools])\n\n return (\n <>\n <div ref={devToolRef} />\n </>\n )\n}\n"],"names":[],"mappings":";;;;AAoCa,MAAA,8BAA8D,CACzE,UAC8B;AAC9B,QAAM,EAAE,QAAQ,aAAa,GAAG,KAAS,IAAA;AACzC,QAAM,aAAa,UAAU,EAAE,MAAM,OAAO;AAC5C,QAAM,eAAe,eAAe;AACpC,QAAM,oBAAoB,eAAe,EAAE,QAAQ,cAAc;AAE3D,QAAA,aAAa,OAAuB,IAAI;AACxC,QAAA,CAAC,QAAQ,IAAI;AAAA,IACjB,MACE,IAAI,gCAAgC;AAAA,MAClC,GAAG;AAAA,MACH,QAAQ;AAAA,MACR,aAAa;AAAA,IACd,CAAA;AAAA,EACL;AAGA,YAAU,MAAM;AACd,aAAS,UAAU,YAAY;AAAA,EAAA,GAC9B,CAAC,UAAU,YAAY,CAAC;AAE3B,YAAU,MAAM;AACd,aAAS,eAAe,iBAAiB;AAAA,EAAA,GACxC,CAAC,UAAU,iBAAiB,CAAC;AAEhC,YAAU,MAAM;AACd,aAAS,WAAW;AAAA,MAClB,WAAW,MAAM;AAAA,MACjB,OAAO,MAAM;AAAA,MACb,iBAAiB,MAAM;AAAA,IAAA,CACxB;AAAA,EAAA,GACA,CAAC,UAAU,MAAM,WAAW,MAAM,OAAO,MAAM,eAAe,CAAC;AAElE,YAAU,MAAM;AACd,QAAI,WAAW,SAAS;AACb,eAAA,MAAM,WAAW,OAAO;AAAA,IAAA;AAGnC,WAAO,MAAM;AACX,eAAS,QAAQ;AAAA,IACnB;AAAA,EAAA,GACC,CAAC,QAAQ,CAAC;AAEb,SAEI,oBAAA,UAAA,EAAA,UAAA,oBAAC,OAAI,EAAA,KAAK,WAAY,CAAA,GACxB;AAEJ;"}
@@ -1,6 +0,0 @@
1
- import * as Devtools from './TanStackRouterDevtools.js';
2
- import * as DevtoolsPanel from './TanStackRouterDevtoolsPanel.js';
3
- export declare const TanStackRouterDevtools: (typeof Devtools)['TanStackRouterDevtools'];
4
- export declare const TanStackRouterDevtoolsInProd: (typeof Devtools)['TanStackRouterDevtools'];
5
- export declare const TanStackRouterDevtoolsPanel: (typeof DevtoolsPanel)['TanStackRouterDevtoolsPanel'];
6
- export declare const TanStackRouterDevtoolsPanelInProd: (typeof DevtoolsPanel)['TanStackRouterDevtoolsPanel'];
package/dist/esm/index.js DELETED
@@ -1,17 +0,0 @@
1
- import { TanStackRouterDevtools as TanStackRouterDevtools$1 } from "./TanStackRouterDevtools.js";
2
- import { TanStackRouterDevtoolsPanel as TanStackRouterDevtoolsPanel$1 } from "./TanStackRouterDevtoolsPanel.js";
3
- const TanStackRouterDevtools = process.env.NODE_ENV !== "development" ? function() {
4
- return null;
5
- } : TanStackRouterDevtools$1;
6
- const TanStackRouterDevtoolsInProd = TanStackRouterDevtools$1;
7
- const TanStackRouterDevtoolsPanel = process.env.NODE_ENV !== "development" ? function() {
8
- return null;
9
- } : TanStackRouterDevtoolsPanel$1;
10
- const TanStackRouterDevtoolsPanelInProd = TanStackRouterDevtoolsPanel$1;
11
- export {
12
- TanStackRouterDevtools,
13
- TanStackRouterDevtoolsInProd,
14
- TanStackRouterDevtoolsPanel,
15
- TanStackRouterDevtoolsPanelInProd
16
- };
17
- //# sourceMappingURL=index.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.js","sources":["../../src/index.ts"],"sourcesContent":["import * as Devtools from './TanStackRouterDevtools'\nimport * as DevtoolsPanel from './TanStackRouterDevtoolsPanel'\n\nexport const TanStackRouterDevtools: (typeof Devtools)['TanStackRouterDevtools'] =\n process.env.NODE_ENV !== 'development'\n ? function () {\n return null\n }\n : Devtools.TanStackRouterDevtools\n\nexport const TanStackRouterDevtoolsInProd: (typeof Devtools)['TanStackRouterDevtools'] =\n Devtools.TanStackRouterDevtools\n\nexport const TanStackRouterDevtoolsPanel: (typeof DevtoolsPanel)['TanStackRouterDevtoolsPanel'] =\n process.env.NODE_ENV !== 'development'\n ? function () {\n return null\n }\n : DevtoolsPanel.TanStackRouterDevtoolsPanel\n\nexport const TanStackRouterDevtoolsPanelInProd: (typeof DevtoolsPanel)['TanStackRouterDevtoolsPanel'] =\n DevtoolsPanel.TanStackRouterDevtoolsPanel\n"],"names":["Devtools.TanStackRouterDevtools","DevtoolsPanel.TanStackRouterDevtoolsPanel"],"mappings":";;AAGO,MAAM,yBACX,QAAQ,IAAI,aAAa,gBACrB,WAAY;AACH,SAAA;AACT,IACAA;AAEC,MAAM,+BACXA;AAEK,MAAM,8BACX,QAAQ,IAAI,aAAa,gBACrB,WAAY;AACH,SAAA;AACT,IACAC;AAEC,MAAM,oCACXA;"}