# Devtools

> 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:
>
> - <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" /> <a href="https://chromewebstore.google.com/detail/tanstack-query-devtools/annajfchloimdhceglpgglpeepfghfai">Devtools for Chrome</a>
> - <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" /> <a href="https://addons.mozilla.org/en-US/firefox/addon/tanstack-query-devtools/">Devtools for Firefox</a>
> - <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" /> <a href="https://microsoftedge.microsoft.com/addons/detail/tanstack-query-devtools/edmdpkgkacmjopodhfolmphdenmddobj">Devtools for Edge</a>

## Enable devtools

Add the devtools package (in addition to `@tanstack/angular-query`):

```sh
npm install @tanstack/angular-query-devtools
```

The devtools help you debug and inspect your queries and mutations. You can enable the devtools by adding `withDevtools` to `provideTanStackQuery`.

By default, Angular Query Devtools only load in development.

```ts
import { QueryClient, provideTanStackQuery } from '@tanstack/angular-query'
import { withDevtools } from '@tanstack/angular-query-devtools'

export const appConfig: ApplicationConfig = {
  providers: [provideTanStackQuery(() => new QueryClient(), withDevtools())],
}
```

## Devtools in production

If you need the real implementation in production, import from the `production` entrypoint.

```ts
import { withDevtools } from '@tanstack/angular-query-devtools/production'
```

To control when devtools are rendered, use the `loadDevtools` option.

When omitted or set to `'auto'`, devtools are only rendered in development mode.

```ts
import { withDevtools } from '@tanstack/angular-query-devtools'

providers: [provideTanStackQuery(() => new QueryClient(), withDevtools())]

// which is equivalent to
providers: [
  provideTanStackQuery(
    () => new QueryClient(),
    withDevtools(() => ({ loadDevtools: 'auto' })),
  ),
]
```

When setting the option to true, the devtools will be rendered in both development and production mode.

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.

```ts
// Make sure to use the production sub-path to load devtools in production builds
import { withDevtools } from '@tanstack/angular-query-devtools/production'
import { environment } from './environments/environment'

providers: [
  provideTanStackQuery(
    () => new QueryClient(),
    withDevtools(() => ({ loadDevtools: environment.loadDevtools })),
  ),
]
```

When setting the option to false, the devtools will not be rendered.

```ts
providers: [
  provideTanStackQuery(
    () => new QueryClient(),
    withDevtools(() => ({ loadDevtools: false })),
  ),
]
```

### Webpack file replacements

Some webpack-based Angular builders do not apply package export conditions when
they bundle application code. Use the explicit `production` and `stub`
entrypoints with Angular CLI file replacements to keep the devtools dependency
out of production bundles.

Create an application-level import that can be replaced:

```ts
// src/app/query-devtools.ts
export { withDevtools } from '@tanstack/angular-query-devtools/production'
```

```ts
// src/app/query-devtools.stub.ts
export { withDevtools } from '@tanstack/angular-query-devtools/stub'
```

Import the application-level module from your config:

```ts
import { withDevtools } from './query-devtools'
```

Then configure the production build:

```json
{
  "configurations": {
    "production": {
      "fileReplacements": [
        {
          "replace": "src/app/query-devtools.ts",
          "with": "src/app/query-devtools.stub.ts"
        }
      ]
    }
  }
}
```

The same pattern is available for the [embedded panel](#embedded-mode):
`@tanstack/angular-query-devtools/devtools-panel/production` and
`@tanstack/angular-query-devtools/devtools-panel/stub`.

## Reactive options

Mutable options can be Angular signals. For example, a signal derived from a keyboard shortcut can show devtools on demand:

```ts
import { Injectable, isDevMode } from '@angular/core'
import { toSignal } from '@angular/core/rxjs-interop'
import { fromEvent, map, scan } from 'rxjs'

@Injectable({ providedIn: 'root' })
export class DevtoolsOptionsManager {
  loadDevtools = toSignal(
    fromEvent<KeyboardEvent>(document, 'keydown').pipe(
      map(
        (event): boolean =>
          event.metaKey && event.ctrlKey && event.shiftKey && event.key === 'D',
      ),
      scan((acc, curr) => acc || curr, isDevMode()),
    ),
    {
      initialValue: isDevMode(),
    },
  )
}
```

The callback runs once in an Angular injection context, so it can call
`inject()`. Return signals as option values to update them reactively:

```ts
// ...
// 👇 Import from the production sub-path to make devtools available in production builds
import { inject } from '@angular/core'
import { withDevtools } from '@tanstack/angular-query-devtools/production'

export const appConfig: ApplicationConfig = {
  providers: [
    provideHttpClient(),
    provideTanStackQuery(
      () => new QueryClient(),
      withDevtools(() => ({
        loadDevtools: inject(DevtoolsOptionsManager).loadDevtools,
      })),
    ),
  ],
}
```

### Options returned from the callback

`loadDevtools`, `client`, `position`, `errorTypes`, `buttonPosition`,
`initialIsOpen`, and `theme` accept either their documented static value or a
signal containing that value.

`styleNonce`, `shadowDOMTarget`, and `hideDisabledQueries` are construction-time
options and do not accept signals.

- `loadDevtools?: 'auto' | boolean`
  - Omit or `'auto'`: load devtools only in development mode.
  - Use this to control whether devtools load when using the `/production` import.
- `initialIsOpen?: Boolean`
  - Set this to `true` if you want the tools to default to being open
- `buttonPosition?: "top-left" | "top-right" | "bottom-left" | "bottom-right" | "relative"`
  - Defaults to `bottom-right`
  - The position of the TanStack logo to open and close the devtools panel
  - If `relative`, the button is placed in the location that you render the devtools.
- `position?: "top" | "bottom" | "left" | "right"`
  - Defaults to `bottom`
  - The position of the Angular Query devtools panel
- `client?: QueryClient`,
  - Use this to use a custom QueryClient. Otherwise, the QueryClient provided through `provideTanStackQuery` will be injected.
- `errorTypes?: { name: string; initializer: (query: Query) => TError}[]`
  - 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.
- `shadowDOMTarget?: ShadowRoot`
  - Default behavior will apply the devtool's styles to the head tag within the DOM.
  - 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.
- `hideDisabledQueries?: boolean`
  - Defaults to `false`.
  - Set this to true to hide disabled queries from the devtools panel.
- `theme?: "light" | "dark" | "system"`
  - Defaults to the theme selected in the devtools Settings menu, or `system` if none is selected.
  - Sets the theme of the devtools panel, overriding the Settings menu selection.

## Embedded Mode

Embedded mode will show the development tools as a fixed element in your application, so you can use our panel in your own development tools.

Use `injectDevtoolsPanel` to render the devtools panel inside an element of your component. Like `withDevtools`, it is only included in development mode bundles. To use it in production builds, import it from `@tanstack/angular-query-devtools/devtools-panel/production`.

```angular-ts
import { Component, signal, viewChild } from '@angular/core'
import { injectDevtoolsPanel } from '@tanstack/angular-query-devtools/devtools-panel'
import type { ElementRef } from '@angular/core'

@Component({
  selector: 'app-root',
  template: `
    <button type="button" (click)="isOpen.set(!isOpen())">
      {{ isOpen() ? 'Close' : 'Open' }} the devtools panel
    </button>
    @if (isOpen()) {
      <div #div style="height: 500px"></div>
    }
  `,
})
export class AppComponent {
  readonly isOpen = signal(false)
  readonly divEl = viewChild<ElementRef>('div')

  readonly devtools = injectDevtoolsPanel(() => ({
    hostElement: this.divEl(),
    onClose: () => this.isOpen.set(false),
  }))
}
```

`injectDevtoolsPanel` must be called in an injection context. To create the panel later, for example after lazy loading the entry point, wrap the call in [`runInInjectionContext`](https://angular.dev/api/core/runInInjectionContext). It returns a `DevtoolsPanelRef`; call its `destroy()` to remove the panel before the injector that created it is destroyed.

See the [devtools panel example](./examples/devtools-panel-angular-router) for both variants.

### Options

The callback is reactive: `hostElement`, `client`, `errorTypes`, `onClose`, and `theme` are applied whenever a signal read in the callback changes.

`styleNonce`, `shadowDOMTarget`, and `hideDisabledQueries` are construction-time
options, read when the panel is created.

- `hostElement?: ElementRef | null`
  - The element to render the devtools panel in. When it is `undefined` or `null`, the devtools panel is not created, or is destroyed if it exists.
- `onClose?: () => unknown`
  - Callback function that is called when the devtools panel is closed
- `client?: QueryClient`,
  - Use this to use a custom QueryClient. Otherwise, the QueryClient provided through `provideTanStackQuery` will be injected.
- `errorTypes?: { name: string; initializer: (query: Query) => TError}[]`
  - 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.
- `shadowDOMTarget?: ShadowRoot`
  - Default behavior will apply the devtool's styles to the head tag within the DOM.
  - 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.
- `hideDisabledQueries?: boolean`
  - Defaults to `false`.
  - Set this to true to hide disabled queries from the devtools panel.
- `theme?: "light" | "dark" | "system"`
  - Defaults to the theme selected in the devtools Settings menu, or `system` if none is selected.
  - Sets the theme of the devtools panel, overriding the Settings menu selection.

## Filter queries and mutations

The **Filter** input above the query and mutation lists uses the **Key** scope by default. Select the scope button inside the input to switch between **Key**, **Data**, and **All**:

- **Key** matches the query hash, or the mutation key and submission time.
- **Data** matches the query data, or the mutation variables or data, the same way **Search data** does below.
- **All** matches either.

The selected scope is remembered across reloads, like the other filter settings.

## Search query and mutation data

Select a query or mutation and use **Search data** in its Data Explorer to search nested property names and primitive values. Search uses case-insensitive text matching and treats special characters as plain text.

Matching text is highlighted. Matching editable values have a highlighted input. The explorer opens matching branches and the first matching page in each paginated collection. Other pages with matches are highlighted so you can open them. You can still inspect other rows and edit query data.

The Data Explorer highlights up to 1,000 matches at a time.

Select **Clear** or press **Escape** in the search field to restore your manual expansion. Selecting another query or mutation clears the search, unless the filter scope is **Data** or **All**: then the search starts with the filter text. For a mutation, it starts only in the variables or data that match the filter.
