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