Open History to see the last commit
1---
2title: Basic setup
3id: basic-setup
4---
5β
6TanStack Devtools provides you with an easy-to-use and modular client that allows you to compose multiple devtools into one easy-to-use panel.
7β
8## Setup
9β
10Install the [TanStack Devtools](https://www.npmjs.com/package/@tanstack/vue-devtools) library. This will install the devtools core as well as provide you with the Vue-specific adapter.
11β
12```bash
13npm i @tanstack/vue-devtools
14```
15β
16Next, in the root of your application, import the `TanStackDevtools` component from `@tanstack/vue-devtools` and add it to your template.
17β
18```vue
19<script setup lang="ts">
20import { TanStackDevtools } from '@tanstack/vue-devtools'
21</script>
22β
23<template>
24 <App />
25 <TanStackDevtools />
26</template>
27```
28β
29Import the desired devtools and provide them to the `TanStackDevtools` component via the `plugins` prop along with a label for the menu.
30β
31Currently TanStack offers:
32β
33- `VueQueryDevtoolsPanel`
34β
35```vue
36<script setup lang="ts">
37import { TanStackDevtools } from '@tanstack/vue-devtools'
38import type { TanStackDevtoolsVuePlugin } from '@tanstack/vue-devtools'
39import { VueQueryDevtoolsPanel } from '@tanstack/vue-query-devtools'
40β
41const plugins: TanStackDevtoolsVuePlugin[] = [
42 {
43 name: 'Vue Query',
44 component: VueQueryDevtoolsPanel,
45 },
46]
47</script>
48β
49<template>
50 <App />
51 <TanStackDevtools
52 :eventBusConfig="{ connectToServerBus: true }"
53 :plugins="plugins"
54 />
55</template>
56```
57β
58> Note: The Vue adapter uses `component` instead of `render` in plugin definitions. In Vue, components are passed as component references rather than JSX elements, and any additional props can be provided via the `props` field.
59β
60Finally, add any additional configuration you desire to the `TanStackDevtools` component. More information can be found under the [TanStack Devtools Configuration](../../configuration) section.
61β
62A complete working example can be found in our [basic example](https://tanstack.com/devtools/latest/docs/framework/vue/examples/basic).