File size: 2,444 Bytes
1e92f2d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 |
'use client'
import * as React from 'react'
import { onlineManager, useQueryClient } from '@tanstack/react-query'
import { TanstackQueryDevtoolsPanel } from '@tanstack/query-devtools'
import type { DevtoolsErrorType } from '@tanstack/query-devtools'
import type { QueryClient } from '@tanstack/react-query'
export interface DevtoolsPanelOptions {
/**
* Custom instance of QueryClient
*/
client?: QueryClient
/**
* Use this so you can define custom errors that can be shown in the devtools.
*/
errorTypes?: Array<DevtoolsErrorType>
/**
* Use this to pass a nonce to the style tag that is added to the document head. This is useful if you are using a Content Security Policy (CSP) nonce to allow inline styles.
*/
styleNonce?: string
/**
* Use this so you can attach the devtool's styles to specific element in the DOM.
*/
shadowDOMTarget?: ShadowRoot
/**
* Custom styles for the devtools panel
* @default { height: '500px' }
* @example { height: '100%' }
* @example { height: '100%', width: '100%' }
*/
style?: React.CSSProperties
/**
* Callback function that is called when the devtools panel is closed
*/
onClose?: () => unknown
}
export function ReactQueryDevtoolsPanel(
props: DevtoolsPanelOptions,
): React.ReactElement | null {
const queryClient = useQueryClient(props.client)
const ref = React.useRef<HTMLDivElement>(null)
const { errorTypes, styleNonce, shadowDOMTarget } = props
const [devtools] = React.useState(
new TanstackQueryDevtoolsPanel({
client: queryClient,
queryFlavor: 'React Query',
version: '5',
onlineManager,
buttonPosition: 'bottom-left',
position: 'bottom',
initialIsOpen: true,
errorTypes,
styleNonce,
shadowDOMTarget,
onClose: props.onClose,
}),
)
React.useEffect(() => {
devtools.setClient(queryClient)
}, [queryClient, devtools])
React.useEffect(() => {
devtools.setOnClose(props.onClose ?? (() => {}))
}, [props.onClose, devtools])
React.useEffect(() => {
devtools.setErrorTypes(errorTypes || [])
}, [errorTypes, devtools])
React.useEffect(() => {
if (ref.current) {
devtools.mount(ref.current)
}
return () => {
devtools.unmount()
}
}, [devtools])
return (
<div
style={{ height: '500px', ...props.style }}
className="tsqd-parent-container"
ref={ref}
></div>
)
}
|