Skip to content
Source
Sign inSign up
TanStack/query
Open History to see the last commit

TanstackQueryDevtoolsPanel.tsx

153 lines4.0 KB

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