Subscribe

Make your life easier with React Query DevTools

✍️

React Query is already pretty amazing, but their DevTools make things even better

6 Feb, 2022 Β· 3 min read

When it comes to using React Query and especially the more advanced topics, it can be pretty hard to debug what's going on.

Or sometimes, you just want to invalidate a query to see if everything works fine quickly.

That's exactly where React Query DevTools come in handy πŸ₯³.

This is what it looks like when enabled:

Make your life easier with React Query DevTools

Enabling React Query DevTools

If you want to use the DevTools, installing them in your main app wrapper is recommended. This way, they will be visible everywhere.

And don't worry, by default, they will only show up when your env is in development mode.

Open up your App.js file and import the DevTools.

import {ReactQueryDevtools} from 'react-query/devtools';

To import it, we should place it inside the QueryClientProvider block like so:

function App() {
  return (
    <QueryClientProvider client={queryClient}>
      # Your app components
      <ReactQueryDevtools />
    </QueryClientProvider>
  );
}

For this mode, we can pass the following optional properties.

  • initialIsOpen: You can set this to true if you want it to default show as open
  • position: Can be one of the following: top-left, top-right, bottom-left, bottom-right, and it determines the position of the React Query logo.

Then we get some options that can be used to extend default styles or click handlers. All of these can be used to override defaults like: className, style and onClick where applicable:

  • panelProps
  • closeButtonProps
  • toggleButtonProps

Alternatively you can render it as a plain component when used in embedded mode:

import {ReactQueryDevtoolsPanel} from 'react-query/devtools';

function App() {
  return (
    <QueryClientProvider client={queryClient}>
      <ReactQueryDevtoolsPanel />
    </QueryClientProvider>
  );
}

Using the React Query DevTools

Once you spool up your application with the DevTools setup, you can quickly keep track of all the fired queries.

By clicking on one of them, you get to see a lot of information for this query.

  • Query key
  • Current status
  • Last updated
  • Data inside the cache

And you can quickly choose any of the following actions:

  • Refetch
  • Invalidate
  • Reset
  • Remove

React Query options

Trust me. React Query DevTools can make your life a lot easier. Knowing when a query is refetched, what data it has, or how many times it retried fetching it is such a win.

Thank you for reading, and let's connect!

Thank you for reading my blog. Feel free to subscribe to my email newsletter and connect on Facebook or Twitter

Spread the knowledge with fellow developers on Twitter
Tweet this tip
Powered by Webmentions - Learn more

Read next πŸ“–

Upgrading to React 18

22 Apr, 2022 Β· 3 min read

Upgrading to React 18

What's new in React 18

21 Apr, 2022 Β· 5 min read

What's new in React 18

Join 1372 devs and subscribe to my newsletter