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

TanstackQueryDevtools.tsx

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