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