2023-12-01 14:09:39 +01:00
---
id: devtools
title: Devtools
---
2025-08-11 13:08:47 +02:00
> 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:
>
2025-08-19 11:59:08 +02:00
> - <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)
> - <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/)
> - <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)
2025-06-19 20:51:01 +02:00
2024-11-07 16:18:52 +01:00
## Enable devtools
2023-12-01 14:09:39 +01:00
2024-11-07 16:18:52 +01:00
The devtools help you debug and inspect your queries and mutations. You can enable the devtools by adding `withDevtools` to `provideTanStackQuery` .
2023-12-01 14:09:39 +01:00
2025-09-16 00:07:53 +02:00
By default, Angular Query Devtools are only included in development mode bundles, so you don't need to worry about excluding them during a production build.
2024-08-19 14:06:40 +05:30
2024-11-07 16:18:52 +01:00
``` ts
import {
QueryClient ,
provideTanStackQuery ,
} from '@tanstack/angular-query-experimental'
2025-09-16 00:07:53 +02:00
import { withDevtools } from '@tanstack/angular-query-experimental/devtools'
2024-11-07 16:18:52 +01:00
export const appConfig : ApplicationConfig = {
providers : [ provideTanStackQuery ( new QueryClient ( ) , withDevtools ( ) ) ] ,
}
2024-08-19 14:06:40 +05:30
```
2025-09-16 00:07:53 +02:00
## Devtools in production
2024-08-19 14:06:40 +05:30
2025-09-16 00:07:53 +02:00
Devtools are automatically excluded from production builds. However, it might be desirable to lazy load the devtools in production.
2024-11-07 16:18:52 +01:00
2025-09-16 00:07:53 +02:00
To use `withDevtools` in production builds, import using the `production` sub-path. The function exported from the production subpath is identical to the main one, but won't be excluded from production builds.
2024-08-19 14:06:40 +05:30
2024-11-07 16:18:52 +01:00
``` ts
2025-09-16 00:07:53 +02:00
import { withDevtools } from '@tanstack/angular-query-experimental/devtools/production'
```
To control when devtools are loaded, you can use the `loadDevtools` option.
When not setting the option or setting it to 'auto', the devtools will be loaded automatically only when Angular runs in development mode.
``` ts
import { withDevtools } from '@tanstack/angular-query-experimental/devtools'
2024-11-07 16:18:52 +01:00
provideTanStackQuery ( new QueryClient ( ) , withDevtools ( ) )
2024-08-19 14:06:40 +05:30
2024-11-07 16:18:52 +01:00
// which is equivalent to
provideTanStackQuery (
new QueryClient ( ) ,
withDevtools ( ( ) = > ( { loadDevtools : 'auto' } ) ) ,
)
2023-12-01 14:09:39 +01:00
```
2024-11-07 16:18:52 +01:00
When setting the option to true, the devtools will be loaded in both development and production mode.
2023-12-01 14:09:39 +01:00
2025-09-16 00:07:53 +02:00
This is useful if you want to load devtools based on [Angular environment configurations ](https://angular.dev/tools/cli/environments ). E.g. you could set this to true when the application is running on your production build staging environment.
2023-12-12 15:39:09 +01:00
``` ts
2025-09-16 00:07:53 +02:00
import { environment } from './environments/environment'
// Make sure to use the production sub-path to load devtools in production builds
import { withDevtools } from '@tanstack/angular-query-experimental/devtools/production'
2024-11-07 16:18:52 +01:00
provideTanStackQuery (
new QueryClient ( ) ,
2025-09-16 00:07:53 +02:00
withDevtools ( ( ) = > ( { loadDevtools : environment.loadDevtools } ) ) ,
2024-11-07 16:18:52 +01:00
)
2023-12-01 14:09:39 +01:00
```
2024-11-07 16:18:52 +01:00
When setting the option to false, the devtools will not be loaded.
2023-12-01 14:09:39 +01:00
2024-11-07 16:18:52 +01:00
``` ts
provideTanStackQuery (
new QueryClient ( ) ,
withDevtools ( ( ) = > ( { loadDevtools : false } ) ) ,
)
```
2023-12-01 14:09:39 +01:00
2025-09-16 00:07:53 +02:00
## Derive options through reactivity
Options are passed to `withDevtools` from a callback function to support reactivity through signals. In the following example
a signal is created from a RxJS observable that emits on a keyboard shortcut. When the derived signal is set to true, the devtools are lazily loaded.
The example below always loads devtools in development mode and loads on-demand in production mode when a keyboard shortcut is pressed.
2023-12-01 14:09:39 +01:00
2024-11-07 16:18:52 +01:00
``` ts
2025-09-16 00:07:53 +02:00
import { Injectable , isDevMode } from '@angular/core'
import { fromEvent , map , scan } from 'rxjs'
import { toSignal } from '@angular/core/rxjs-interop'
2024-11-07 16:18:52 +01:00
@Injectable ( { providedIn : 'root' } )
2025-09-16 00:07:53 +02:00
export class DevtoolsOptionsManager {
2024-11-07 16:18:52 +01:00
loadDevtools = toSignal (
fromEvent < KeyboardEvent > ( document , 'keydown' ) . pipe (
map (
( event ) : boolean = >
event . metaKey && event . ctrlKey && event . shiftKey && event . key === 'D' ,
) ,
2025-09-16 00:07:53 +02:00
scan ( ( acc , curr ) = > acc || curr , isDevMode ( ) ) ,
2024-11-07 16:18:52 +01:00
) ,
{
2025-09-16 00:07:53 +02:00
initialValue : isDevMode ( ) ,
2024-11-07 16:18:52 +01:00
} ,
)
}
2025-09-16 00:07:53 +02:00
```
If you want to use an injectable such as a service in the callback you can use `deps` . The injected value will be passed as parameter to the callback function.
This is similar to `deps` in Angular's [`useFactory` ](https://angular.dev/guide/di/dependency-injection-providers#factory-providers-usefactory ) provider.
``` ts
// ...
// 👇 Note we import from the production sub-path to enable devtools lazy loading in production builds
import { withDevtools } from '@tanstack/angular-query-experimental/devtools/production'
2024-11-07 16:18:52 +01:00
export const appConfig : ApplicationConfig = {
providers : [
provideHttpClient ( ) ,
provideTanStackQuery (
new QueryClient ( ) ,
2025-09-16 00:07:53 +02:00
withDevtools (
( devToolsOptionsManager : DevtoolsOptionsManager ) = > ( {
loadDevtools : devToolsOptionsManager.loadDevtools ( ) ,
} ) ,
{
// `deps` is used to inject and pass `DevtoolsOptionsManager` to the `withDevtools` callback.
deps : [ DevtoolsOptionsManager ] ,
} ,
) ,
2024-11-07 16:18:52 +01:00
) ,
] ,
}
2023-12-01 14:09:39 +01:00
```
2025-09-16 00:07:53 +02:00
### Options returned from the callback
2023-12-01 14:09:39 +01:00
2025-09-16 00:07:53 +02:00
Of these options `loadDevtools` , `client` , `position` , `errorTypes` , `buttonPosition` , and `initialIsOpen` support reactivity through signals.
2024-11-07 16:18:52 +01:00
- `loadDevtools?: 'auto' | boolean`
- Defaults to `auto` : lazily loads devtools when in development mode. Skips loading in production mode.
- Use this to control if the devtools are loaded.
- `initialIsOpen?: Boolean`
- Set this to `true` if you want the tools to default to being open
2024-02-16 23:34:19 +01:00
- `buttonPosition?: "top-left" | "top-right" | "bottom-left" | "bottom-right" | "relative"`
2024-01-17 18:59:02 -03:00
- Defaults to `bottom-right`
2023-12-01 14:09:39 +01:00
- The position of the TanStack logo to open and close the devtools panel
2024-02-16 23:34:19 +01:00
- If `relative` , the button is placed in the location that you render the devtools.
2023-12-01 14:09:39 +01:00
- `position?: "top" | "bottom" | "left" | "right"`
- Defaults to `bottom`
- The position of the Angular Query devtools panel
- `client?: QueryClient` ,
2024-11-07 16:18:52 +01:00
- Use this to use a custom QueryClient. Otherwise, the QueryClient provided through `provideTanStackQuery` will be injected.
- `errorTypes?: { name: string; initializer: (query: Query) => TError}[]`
2024-01-17 02:10:36 +01:00
- 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.
- `styleNonce?: string`
- 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.
2024-03-11 23:19:54 -03:00
- `shadowDOMTarget?: ShadowRoot`
- Default behavior will apply the devtool's styles to the head tag within the DOM.
2024-08-19 17:50:53 +05:30
- 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.
2025-09-16 00:07:53 +02:00
- `hideDisabledQueries?: boolean`
- Set this to true to hide disabled queries from the devtools panel.
