Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/lazy-devtools-instance.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@tanstack/react-query-devtools': patch
---

fix(react-query-devtools): create the devtools instance only once instead of on every render
29 changes: 15 additions & 14 deletions packages/react-query-devtools/src/ReactQueryDevtools.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -73,20 +73,21 @@ export function ReactQueryDevtools(
theme,
} = props
const [devtools] = React.useState(
new TanstackQueryDevtools({
client: queryClient,
queryFlavor: 'React Query',
version: '5',
onlineManager,
buttonPosition,
position,
initialIsOpen,
errorTypes,
styleNonce,
shadowDOMTarget,
hideDisabledQueries,
theme,
}),
() =>
new TanstackQueryDevtools({
client: queryClient,
queryFlavor: 'React Query',
version: '5',
onlineManager,
buttonPosition,
position,
initialIsOpen,
errorTypes,
styleNonce,
shadowDOMTarget,
hideDisabledQueries,
theme,
}),
)

React.useEffect(() => {
Expand Down
31 changes: 16 additions & 15 deletions packages/react-query-devtools/src/ReactQueryDevtoolsPanel.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -60,21 +60,22 @@ export function ReactQueryDevtoolsPanel(
theme,
} = 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,
hideDisabledQueries,
theme,
}),
() =>
new TanstackQueryDevtoolsPanel({
client: queryClient,
queryFlavor: 'React Query',
version: '5',
onlineManager,
buttonPosition: 'bottom-left',
position: 'bottom',
initialIsOpen: true,
errorTypes,
styleNonce,
shadowDOMTarget,
onClose: props.onClose,
hideDisabledQueries,
theme,
}),
)

React.useEffect(() => {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,16 @@ describe('ReactQueryDevtools', () => {
)
})

it('should create the devtools instance only once across re-renders', () => {
const { rerender } = render(
<ReactQueryDevtools client={queryClient} position="bottom" />,
)

rerender(<ReactQueryDevtools client={queryClient} position="top" />)

expect(TanstackQueryDevtools).toHaveBeenCalledTimes(1)
})

it('should forward a "buttonPosition" change to the devtools instance after mount', () => {
const { rerender } = render(
<ReactQueryDevtools client={queryClient} buttonPosition="bottom-right" />,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,16 @@ describe('ReactQueryDevtoolsPanel', () => {
)
})

it('should create the devtools instance only once across re-renders', () => {
const { rerender } = render(
<ReactQueryDevtoolsPanel client={queryClient} errorTypes={[]} />,
)

rerender(<ReactQueryDevtoolsPanel client={queryClient} errorTypes={[]} />)

expect(TanstackQueryDevtoolsPanel).toHaveBeenCalledTimes(1)
})

it('should preserve the default container height when "style" omits "height"', () => {
const { container } = render(
<ReactQueryDevtoolsPanel
Expand Down
Loading