Open History to see the last commit
1import { TanStackRouterDevtoolsCore } from '@tanstack/router-devtools-core'
2import { Fragment, useEffect, useRef, useState } from 'react'
3import { useRouter, useRouterState } from '@tanstack/react-router'
4import type { ButtonHTMLAttributes, HTMLAttributes } from 'react'
5import type { AnyRouter } from '@tanstack/react-router'
6import type React from 'react'
7β
8interface DevtoolsOptions {
9 /**
10 * Set this true if you want the dev tools to default to being open
11 */
12 initialIsOpen?: boolean
13 /**
14 * Use this to add props to the panel. For example, you can add className, style (merge and override default style), etc.
15 */
16 panelProps?: HTMLAttributes<HTMLDivElement>
17 /**
18 * 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.
19 */
20 closeButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>
21 /**
22 * 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.
23 */
24 toggleButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>
25 /**
26 * The position of the TanStack Router logo to open and close the devtools panel.
27 * Defaults to 'bottom-left'.
28 */
29 position?: 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'
30 /**
31 * Use this to render the devtools inside a different type of container element for a11y purposes.
32 * Any string which corresponds to a valid intrinsic JSX element is allowed.
33 * Defaults to 'footer'.
34 */
35 containerElement?: string | any
36 /**
37 * The router instance to use for the devtools.
38 */
39 router?: AnyRouter
40 /**
41 * Use this to attach the devtool's styles to specific element in the DOM.
42 */
43 shadowDOMTarget?: ShadowRoot
44}
45β
46export function TanStackRouterDevtools(
47 props: DevtoolsOptions,
48): React.ReactElement | null {
49 const {
50 initialIsOpen,
51 panelProps,
52 closeButtonProps,
53 toggleButtonProps,
54 position,
55 containerElement,
56 shadowDOMTarget,
57 router: propsRouter,
58 } = props
59β
60 const hookRouter = useRouter({ warn: false })
61 const activeRouter = propsRouter ?? hookRouter
62β
63 const activeRouterState = useRouterState({ router: activeRouter })
64β
65 const devToolRef = useRef<HTMLDivElement>(null)
66 const [devtools] = useState(
67 () =>
68 new TanStackRouterDevtoolsCore({
69 initialIsOpen,
70 panelProps,
71 closeButtonProps,
72 toggleButtonProps,
73 position,
74 containerElement,
75 shadowDOMTarget,
76 router: activeRouter,
77 routerState: activeRouterState,
78 }),
79 )
80β
81 // Update devtools when props change
82 useEffect(() => {
83 devtools.setRouter(activeRouter)
84 }, [devtools, activeRouter])
85β
86 useEffect(() => {
87 devtools.setRouterState(activeRouterState)
88 }, [devtools, activeRouterState])
89β
90 useEffect(() => {
91 devtools.setOptions({
92 initialIsOpen: initialIsOpen,
93 panelProps: panelProps,
94 closeButtonProps: closeButtonProps,
95 toggleButtonProps: toggleButtonProps,
96 position: position,
97 containerElement: containerElement,
98 shadowDOMTarget: shadowDOMTarget,
99 })
100 }, [
101 devtools,
102 initialIsOpen,
103 panelProps,
104 closeButtonProps,
105 toggleButtonProps,
106 position,
107 containerElement,
108 shadowDOMTarget,
109 ])
110β
111 useEffect(() => {
112 if (devToolRef.current) {
113 devtools.mount(devToolRef.current)
114 }
115β
116 return () => {
117 devtools.unmount()
118 }
119 }, [devtools])
120β
121 return (
122 <Fragment>
123 <div ref={devToolRef} />
124 </Fragment>
125 )
126}