---
title: Devtools
id: devtools
---
TanStack Table provides framework-specific devtools adapters that plug into the [TanStack Devtools](https://tanstack.com/devtools) multi-panel UI.
The table devtools let you inspect registered table instances, switch between multiple tables, and inspect features, state, options, rows, and columns in real time.
> [!NOTE]
> By default, the framework adapters only include the live devtools in development mode. In production builds they export no-op implementations unless you opt into the `/production` entrypoints.
## Installation
Install the TanStack Devtools host package and the Table adapter for your framework.
# React
```sh
npm install @tanstack/react-devtools @tanstack/react-table-devtools
```
# Preact
```sh
npm install @tanstack/preact-devtools @tanstack/preact-table-devtools
```
# Octane
There is not currently a dedicated Octane Table Devtools adapter.
# Vue
```sh
npm install @tanstack/vue-devtools @tanstack/vue-table-devtools
```
# Solid
```sh
npm install @tanstack/solid-devtools @tanstack/solid-table-devtools
```
# Angular
```sh
npm install @tanstack/angular-devtools @tanstack/angular-table-devtools
```
Octane, Lit, Svelte, Alpine, and vanilla do not currently ship dedicated table devtools adapters.
## The Required `key` Table Option
The devtools identify each table by the `key` table option. Registration requires it. If you register a table without a `key`, the devtools log an error (`Missing table key. Add a 'key' option to your table to use devtools.`) and skip the table entirely.
```ts
const table = useTable({
key: 'users-table', // needed for devtools, omit if you don't want to use the devtools
features,
columns,
data,
})
```
The `key` is also the label shown in the devtools panel selector, so give each table a unique, descriptive key.
## Setup Pattern
The recommended setup has three parts:
1. Give each table a unique `key` option
2. Mount `TanStackDevtools` at the app root with `tableDevtoolsPlugin()`
3. Register each table with `useTanStackTableDevtools(table)` (or `injectTanStackTableDevtools` in Angular) immediately after creating it
If you register multiple tables, the Table panel shows a selector so you can switch between them.
## Setup
# React
```tsx
import React from 'react'
import ReactDOM from 'react-dom/client'
import { useTable } from '@tanstack/react-table'
import { TanStackDevtools } from '@tanstack/react-devtools'
import {
tableDevtoolsPlugin,
useTanStackTableDevtools,
} from '@tanstack/react-table-devtools'
function App() {
const table = useTable({
key: 'users-table', // needed for devtools
// ...
})
useTanStackTableDevtools(table)
return
}
ReactDOM.createRoot(document.getElementById('root')!).render(
,
)
```
See the [React row-selection example](./framework/react/examples/row-selection).
# Preact
```tsx
import { render } from 'preact'
import { useTable } from '@tanstack/preact-table'
import { TanStackDevtools } from '@tanstack/preact-devtools'
import {
tableDevtoolsPlugin,
useTanStackTableDevtools,
} from '@tanstack/preact-table-devtools'
function App() {
const table = useTable({
key: 'users-table', // needed for devtools
// ...
})
useTanStackTableDevtools(table)
return
}
render(
<>
>,
document.getElementById('root')!,
)
```
# Octane
Octane tables expose the same `table.state`, slice atoms, `table.store`, and `table.Subscribe` inspection surfaces, but there is not currently an Octane Table Devtools plugin to register.
See the [Preact row-selection example](./framework/preact/examples/row-selection).
# Vue
```ts
// main.ts
import { createApp, defineComponent, h } from 'vue'
import { TanStackDevtools } from '@tanstack/vue-devtools'
import { tableDevtoolsPlugin } from '@tanstack/vue-table-devtools'
import App from './App.vue'
const Root = defineComponent({
setup() {
return () => [
h(App),
h(TanStackDevtools, {
plugins: [tableDevtoolsPlugin({})],
}),
]
},
})
createApp(Root).mount('#app')
```
```vue
```
See the [Vue row-selection example](./framework/vue/examples/row-selection).
# Solid
```tsx
import { render } from 'solid-js/web'
import { createTable } from '@tanstack/solid-table'
import { TanStackDevtools } from '@tanstack/solid-devtools'
import {
tableDevtoolsPlugin,
useTanStackTableDevtools,
} from '@tanstack/solid-table-devtools'
function App() {
const table = createTable({
key: 'users-table', // needed for devtools
// ...
})
useTanStackTableDevtools(table)
return
}
render(
() => (
<>
>
),
document.getElementById('root')!,
)
```
See the [Solid row-selection example](./framework/solid/examples/row-selection).
# Angular
Provide the devtools host once in your application config, rendering the table panel from `@tanstack/angular-table-devtools`:
```ts
// app.config.ts
import { isDevMode } from '@angular/core'
import { provideTanStackDevtools } from '@tanstack/angular-devtools/provider'
import type { ApplicationConfig } from '@angular/core'
export const appConfig: ApplicationConfig = {
providers: [
isDevMode()
? provideTanStackDevtools(() => ({
plugins: [
{
name: 'TanStack Table',
render: () =>
import('@tanstack/angular-table-devtools').then((m) =>
m.TableDevtoolsPanel(),
),
},
],
}))
: [],
],
}
```
Then register each table with `injectTanStackTableDevtools` in an injection context (such as a component constructor):
```ts
import { Component } from '@angular/core'
import { injectTable } from '@tanstack/angular-table'
import { injectTanStackTableDevtools } from '@tanstack/angular-table-devtools'
@Component({
// ...
})
export class App {
constructor() {
injectTanStackTableDevtools(() => ({
table: this.table,
}))
}
readonly table = injectTable(() => ({
key: 'users-table', // needed for devtools
// ...
}))
}
```
See the [Angular basic example](./framework/angular/examples/basic-inject-table) or the [Angular row-selection example](./framework/angular/examples/row-selection).
## Disabling Registration
Each registration function accepts an `enabled` option if you want to conditionally register a table:
# React
```ts
useTanStackTableDevtools(table, { enabled: false })
```
# Preact
```ts
useTanStackTableDevtools(table, { enabled: false })
```
# Octane
No adapter toggle is required because Octane does not currently ship a Table Devtools adapter.
# Vue
```ts
useTanStackTableDevtools(table, { enabled: false })
```
# Solid
```ts
useTanStackTableDevtools(table, { enabled: false })
```
# Angular
```ts
injectTanStackTableDevtools(() => ({
table: this.table,
enabled: () => false,
}))
```
## Production Builds
If you need the live devtools in production, import from the `/production` entrypoint for your framework package:
# React
```tsx
import {
tableDevtoolsPlugin,
useTanStackTableDevtools,
} from '@tanstack/react-table-devtools/production'
```
# Preact
```tsx
import {
tableDevtoolsPlugin,
useTanStackTableDevtools,
} from '@tanstack/preact-table-devtools/production'
```
# Octane
There is no production Devtools entry point for Octane Table at this time.
# Vue
```tsx
import {
tableDevtoolsPlugin,
useTanStackTableDevtools,
} from '@tanstack/vue-table-devtools/production'
```
# Solid
```tsx
import {
tableDevtoolsPlugin,
useTanStackTableDevtools,
} from '@tanstack/solid-table-devtools/production'
```
# Angular
```ts
import { injectTanStackTableDevtools } from '@tanstack/angular-table-devtools/production'
```