Devtools

Wave your hands in the air and shout hooray because React Query comes with dedicated devtools! 🥳

When you begin your React Query journey, you'll want these devtools by your side. They help visualize all of the inner workings of React Query and will likely save you hours of debugging if you find yourself in a pinch!

Installation

1 $ npm i --save react-query-devtools
2 # or
3 $ yarn add react-query-devtools

Using React Native? Try react-query-native-devtools instead.

Usage

By default, React Query Devtools are not imported and used when process.env.NODE_ENV === 'production', so you don't need to worry about excluding them during a production build.

If you want to use the devtools in production, you can manually import them (preferably asynchronously code-split) by importing the dist/react-query-devtools.production.min.js file directly.

Floating Mode

Floating Mode will mount the devtools as a fixed, floating element in your app and provide a toggle in the corner of the screen to show and hide the devtools. This toggle state will be stored and remembered in localStorage across reloads.

Place the following code as high in your React app as you can. The closer it is to the root of the page, the better it will work!

1 import { ReactQueryDevtools } from 'react-query-devtools'
2 
3 function App() {
4   return (
5     <>
6       {/* The rest of your application */}
7       <ReactQueryDevtools initialIsOpen={false} />
8     </>
9   )
10 }

Options

• initialIsOpen: Boolean
  • Set this true if you want the dev tools to default to being open
• panelProps: PropsObject
  • Use this to add props to the panel. For example, you can add className, style (merge and override default style), etc.
• closeButtonProps: PropsObject
  • Use this to add props to the close button. For example, you can add className, style (merge and override default style), onClick (extend default handler), etc.
• toggleButtonProps: PropsObject
  • Use this to add props to the toggle button. For example, you can add className, style (merge and override default style), onClick (extend default handler), etc.

Embedded Mode

Embedded Mode will embed the devtools as a regular component in your application. You can style it however you'd like after that!

1 import { ReactQueryDevtoolsPanel } from 'react-query-devtools'
2 
3 function App() {
4   return (
5     <>
6       {/* The rest of your application */}
7       <ReactQueryDevtoolsPanel style={styles} className={className} />
8     </>
9   )
10 }

Options

Use these options to style the dev tools.

• style: StyleObject
  • The standard React style object used to style a component with inline styles
• className: string
  • The standard React className property used to style a component with classes