|
| 1 | +--- |
| 2 | +id: devtools |
| 3 | +title: Devtools |
| 4 | +--- |
| 5 | + |
| 6 | +Wave your hands in the air and shout hooray because Preact Query comes with dedicated devtools! 🥳 |
| 7 | + |
| 8 | +When you begin your Preact Query journey, you'll want these devtools by your side. They help visualize all of the inner workings of Preact Query and will likely save you hours of debugging if you find yourself in a pinch! |
| 9 | + |
| 10 | +> For Chrome, Firefox, and Edge users: Third-party browser extensions are available for debugging TanStack Query directly in browser DevTools. These provide the same functionality as the framework-specific devtools packages: |
| 11 | +> |
| 12 | +> - <img alt="Chrome logo" src="https://www.google.com/chrome/static/images/chrome-logo.svg" width="16" height="16" class="inline mr-1 not-prose" /> [Devtools for Chrome](https://chromewebstore.google.com/detail/tanstack-query-devtools/annajfchloimdhceglpgglpeepfghfai) |
| 13 | +> - <img alt="Firefox logo" src="https://upload.wikimedia.org/wikipedia/commons/a/a0/Firefox_logo%2C_2019.svg" width="16" height="16" class="inline mr-1 not-prose" /> [Devtools for Firefox](https://addons.mozilla.org/en-US/firefox/addon/tanstack-query-devtools/) |
| 14 | +> - <img alt="Edge logo" src="https://upload.wikimedia.org/wikipedia/commons/9/98/Microsoft_Edge_logo_%282019%29.svg" width="16" height="16" class="inline mr-1 not-prose" /> [Devtools for Edge](https://microsoftedge.microsoft.com/addons/detail/tanstack-query-devtools/edmdpkgkacmjopodhfolmphdenmddobj) |
| 15 | +
|
| 16 | +## Install and Import the Devtools |
| 17 | + |
| 18 | +The devtools are a separate package that you need to install: |
| 19 | + |
| 20 | +```bash |
| 21 | +npm i @tanstack/preact-query-devtools |
| 22 | +``` |
| 23 | + |
| 24 | +or |
| 25 | + |
| 26 | +```bash |
| 27 | +pnpm add @tanstack/preact-query-devtools |
| 28 | +``` |
| 29 | + |
| 30 | +or |
| 31 | + |
| 32 | +```bash |
| 33 | +yarn add @tanstack/preact-query-devtools |
| 34 | +``` |
| 35 | + |
| 36 | +or |
| 37 | + |
| 38 | +```bash |
| 39 | +bun add @tanstack/preact-query-devtools |
| 40 | +``` |
| 41 | + |
| 42 | +You can import the devtools like this: |
| 43 | + |
| 44 | +```tsx |
| 45 | +import { PreactQueryDevtools } from '@tanstack/preact-query-devtools' |
| 46 | +``` |
| 47 | + |
| 48 | +By default, Preact Query Devtools are only included in bundles when `process.env.NODE_ENV === 'development'`, so you don't need to worry about excluding them during a production build. |
| 49 | + |
| 50 | +## Floating Mode |
| 51 | + |
| 52 | +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. |
| 53 | + |
| 54 | +Place the following code as high in your Preact app as you can. The closer it is to the root of the page, the better it will work! |
| 55 | + |
| 56 | +```tsx |
| 57 | +import { PreactQueryDevtools } from '@tanstack/preact-query-devtools' |
| 58 | + |
| 59 | +function App() { |
| 60 | + return ( |
| 61 | + <QueryClientProvider client={queryClient}> |
| 62 | + {/* The rest of your application */} |
| 63 | + <PreactQueryDevtools initialIsOpen={false} /> |
| 64 | + </QueryClientProvider> |
| 65 | + ) |
| 66 | +} |
| 67 | +``` |
| 68 | + |
| 69 | +### Options |
| 70 | + |
| 71 | +- `initialIsOpen: boolean` |
| 72 | + - Set this `true` if you want the dev tools to default to being open |
| 73 | +- `buttonPosition?: "top-left" | "top-right" | "bottom-left" | "bottom-right"` |
| 74 | + - Defaults to `bottom-right` |
| 75 | + - The position of the Preact Query logo to open and close the devtools panel |
| 76 | +- `position?: "top" | "bottom" | "left" | "right"` |
| 77 | + - Defaults to `bottom` |
| 78 | + - The position of the Preact Query devtools panel |
| 79 | +- `client?: QueryClient`, |
| 80 | + - Use this to use a custom QueryClient. Otherwise, the one from the nearest context will be used. |
| 81 | +- `errorTypes?: { name: string; initializer: (query: Query) => TError}` |
| 82 | + - Use this to predefine some errors that can be triggered on your queries. Initializer will be called (with the specific query) when that error is toggled on from the UI. It must return an Error. |
| 83 | +- `styleNonce?: string` |
| 84 | + - 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. |
| 85 | +- `shadowDOMTarget?: ShadowRoot` |
| 86 | + - Default behavior will apply the devtool's styles to the head tag within the DOM. |
| 87 | + - Use this to pass a shadow DOM target to the devtools so that the styles will be applied within the shadow DOM instead of within the head tag in the light DOM. |
0 commit comments