> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.

# Vue

Storybook for Vue & Rsbuild helps you preview and iterate on Vue components with the same Rsbuild configuration you use for your application.

## Requirements


| Package | Version |
| --- | --- |
| `vue` | ≥ 3 |
| `@rsbuild/core` | `^1.5.0 \|\| ^2.0.0-0` |
| `storybook` | `^10.6.0` |


## Getting started

Use the steps below in an existing Rsbuild-based Vue project.

### Installation

Install the Vue framework package and `@rsbuild/core`. Even though `storybook-vue3-rsbuild` declares `@rsbuild/core` as a peer, list it as a direct dev dependency so version pins and lockfile audits remain unambiguous.


```sh [npm]
npm install @rsbuild/core storybook-vue3-rsbuild -D
```

```sh [yarn]
yarn add @rsbuild/core storybook-vue3-rsbuild -D
```

```sh [pnpm]
pnpm add @rsbuild/core storybook-vue3-rsbuild -D
```

```sh [bun]
bun add @rsbuild/core storybook-vue3-rsbuild -D
```

```sh [deno]
deno add npm:@rsbuild/core npm:storybook-vue3-rsbuild -D
```

### Configure `.storybook/main.ts`

```js
import { StorybookConfig } from 'storybook-vue3-rsbuild'
import { mergeRsbuildConfig } from '@rsbuild/core'

const config: StorybookConfig = {
  framework: 'storybook-vue3-rsbuild',
  stories: ['../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],
  rsbuildFinal: (config) => {
    // Customize the final Rsbuild config here
    return mergeRsbuildConfig(config, {
      // your custom config
    })
  },
}

export default config
```

You're ready to go! Check the [Vue 3 sandbox](https://github.com/rstackjs/storybook-rsbuild/tree/main/sandboxes/vue3) for a complete reference, and explore the [Storybook docs](https://storybook.js.org/docs) for feature guides.

## Next Steps

Now that Storybook is running, explore how to create stories for your Vue components:

- **[Writing Stories](https://storybook.js.org/docs/writing-stories)**: Learn the Component Story Format (CSF).
- **[Vue Essentials](https://storybook.js.org/docs/get-started/frameworks/vue3-vite)**: Specific guides for Vue development in Storybook.

## Options

Please refer to the [Configuration Guide](/guide/configuration.md#framework-options) for framework-specific options and defaults.