Open History to see the last commit
1import { render } from 'solid-js/web'
2import { createSignal, lazy } from 'solid-js'
3import { setupStyleSheet } from './utils'
4import type {
5 QueryClient,
6 onlineManager as TOnlineManager,
7} from '@tanstack/query-core'
8import type { DevtoolsComponentType } from './Devtools'
9import type {
10 DevtoolsButtonPosition,
11 DevtoolsErrorType,
12 DevtoolsPosition,
13 QueryDevtoolsProps,
14 Theme,
15} from './contexts'
16import type { Signal } from 'solid-js'
17β
18export interface TanstackQueryDevtoolsPanelConfig extends QueryDevtoolsProps {
19 styleNonce?: string
20 shadowDOMTarget?: ShadowRoot
21 onClose?: () => unknown
22}
23β
24class TanstackQueryDevtoolsPanel {
25 #client: Signal<QueryClient>
26 #onlineManager: typeof TOnlineManager
27 #queryFlavor: string
28 #version: string
29 #isMounted = false
30 #styleNonce?: string
31 #shadowDOMTarget?: ShadowRoot
32 #buttonPosition: Signal<DevtoolsButtonPosition | undefined>
33 #position: Signal<DevtoolsPosition | undefined>
34 #initialIsOpen: Signal<boolean | undefined>
35 #errorTypes: Signal<Array<DevtoolsErrorType> | undefined>
36 #hideDisabledQueries: Signal<boolean | undefined>
37 #onClose: Signal<(() => unknown) | undefined>
38 #Component: DevtoolsComponentType | undefined
39 #theme: Signal<Theme | undefined>
40 #dispose?: () => void
41β
42 constructor(config: TanstackQueryDevtoolsPanelConfig) {
43 const {
44 client,
45 queryFlavor,
46 version,
47 onlineManager,
48 buttonPosition,
49 position,
50 initialIsOpen,
51 errorTypes,
52 styleNonce,
53 shadowDOMTarget,
54 onClose,
55 hideDisabledQueries,
56 theme,
57 } = config
58 this.#client = createSignal(client)
59 this.#queryFlavor = queryFlavor
60 this.#version = version
61 this.#onlineManager = onlineManager
62 this.#styleNonce = styleNonce
63 this.#shadowDOMTarget = shadowDOMTarget
64 this.#buttonPosition = createSignal(buttonPosition)
65 this.#position = createSignal(position)
66 this.#initialIsOpen = createSignal(initialIsOpen)
67 this.#errorTypes = createSignal(errorTypes)
68 this.#hideDisabledQueries = createSignal(hideDisabledQueries)
69 this.#onClose = createSignal(onClose)
70 this.#theme = createSignal(theme)
71 }
72β
73 setButtonPosition(position: DevtoolsButtonPosition) {
74 this.#buttonPosition[1](position)
75 }
76β
77 setPosition(position: DevtoolsPosition) {
78 this.#position[1](position)
79 }
80β
81 setInitialIsOpen(isOpen: boolean) {
82 this.#initialIsOpen[1](isOpen)
83 }
84β
85 setErrorTypes(errorTypes: Array<DevtoolsErrorType>) {
86 this.#errorTypes[1](errorTypes)
87 }
88β
89 setClient(client: QueryClient) {
90 this.#client[1](client)
91 }
92β
93 setOnClose(onClose: () => unknown) {
94 this.#onClose[1](() => onClose)
95 }
96β
97 setTheme(theme?: Theme) {
98 this.#theme[1](theme)
99 }
100β
101 mount<T extends HTMLElement>(el: T) {
102 if (this.#isMounted) {
103 throw new Error('Devtools is already mounted')
104 }
105 const dispose = render(() => {
106 const [btnPosition] = this.#buttonPosition
107 const [pos] = this.#position
108 const [isOpen] = this.#initialIsOpen
109 const [errors] = this.#errorTypes
110 const [hideDisabledQueries] = this.#hideDisabledQueries
111 const [queryClient] = this.#client
112 const [onClose] = this.#onClose
113 const [theme] = this.#theme
114 let Devtools: DevtoolsComponentType
115β
116 if (this.#Component) {
117 Devtools = this.#Component
118 } else {
119 Devtools = lazy(() => import('./DevtoolsPanelComponent'))
120 this.#Component = Devtools
121 }
122β
123 setupStyleSheet(this.#styleNonce, this.#shadowDOMTarget)
124 return (
125 <Devtools
126 queryFlavor={this.#queryFlavor}
127 version={this.#version}
128 onlineManager={this.#onlineManager}
129 shadowDOMTarget={this.#shadowDOMTarget}
130 {...{
131 get client() {
132 return queryClient()
133 },
134 get buttonPosition() {
135 return btnPosition()
136 },
137 get position() {
138 return pos()
139 },
140 get initialIsOpen() {
141 return isOpen()
142 },
143 get errorTypes() {
144 return errors()
145 },
146 get hideDisabledQueries() {
147 return hideDisabledQueries()
148 },
149 get onClose() {
150 return onClose()
151 },
152 get theme() {
153 return theme()
154 },
155 }}
156 />
157 )
158 }, el)
159 this.#isMounted = true
160 this.#dispose = dispose
161 }
162β
163 unmount() {
164 if (!this.#isMounted) {
165 throw new Error('Devtools is not mounted')
166 }
167 this.#dispose?.()
168 this.#isMounted = false
169 }
170}
171β
172export { TanstackQueryDevtoolsPanel }