storybook/docs/get-started/vue3-webpack5.md

title
Storybook for Vue & Webpack

export const SUPPORTED_RENDERER = 'vue';

Storybook for Vue & Webpack is a framework that makes it easy to develop and test UI components in isolation for Vue applications built with Webpack.

Storybook for Vue & Webpack is only supported in Vue projects.

Requirements

• Vue ≥ 3.0
• Webpack ≥ 5.0
• Storybook ≥ 8.0

Getting started

In a project without Storybook

Follow the prompts after running this command in your Vue project's root directory:

<CodeSnippets paths={[ 'common/init-command.npx.js.mdx', 'common/init-command.yarn.js.mdx', 'common/init-command.pnpm.js.mdx', ]} />

More on getting started with Storybook.

In a project with Storybook

This framework is designed to work with Storybook 7+. If you’re not already using v7, upgrade with this command:

<CodeSnippets paths={[ 'common/storybook-upgrade.npm.js.mdx', 'common/storybook-upgrade.pnpm.js.mdx', 'common/storybook-upgrade.yarn.js.mdx' ]} />

Automatic migration

When running the upgrade command above, you should get a prompt asking you to migrate to @storybook/vue3-webpack5, which should handle everything for you. In case that auto-migration does not work for your project, refer to the manual migration below.

Manual migration

First, install the framework:

<CodeSnippets paths={[ 'vue/vue-webpack5-install.npm.js.mdx', 'vue/vue-webpack5-install.pnpm.js.mdx', 'vue/vue-webpack5-install.yarn.js.mdx' ]} />

Next, install and register your appropriate compiler addon, depending on whether you're using SWC (recommended) or Babel:

<CodeSnippets paths={[ 'common/storybook-addon-compiler-swc-auto-install.npm.js.mdx', 'common/storybook-addon-compiler-swc-auto-install.pnpm.js.mdx', 'common/storybook-addon-compiler-swc-auto-install.yarn.js.mdx', ]} />

or

<CodeSnippets paths={[ 'common/storybook-addon-compiler-babel-auto-install.npm.js.mdx', 'common/storybook-addon-compiler-babel-auto-install.pnpm.js.mdx', 'common/storybook-addon-compiler-babel-auto-install.yarn.js.mdx', ]} />

More details can be found in the Webpack builder docs.

Finally, update your .storybook/main.js|ts to change the framework property:

<CodeSnippets paths={[ 'vue/vue-webpack5-add-framework.js.mdx', 'vue/vue-webpack5-add-framework.ts.mdx' ]} />

Extending the Vue application

Storybook creates a Vue 3 application for your component preview. When using global custom components (app.component), directives (app.directive), extensions (app.use), or other application methods, you will need to configure those in the ./storybook/preview.js file.

Therefore, Storybook provides you with a setup function exported from this package, which receives as a callback your Storybook instance, which you can interact with and add your custom configuration.

// .storybook/preview.js

import { setup } from '@storybook/vue3';

setup((app) => {
  app.use(MyPlugin);
  app.component('my-component', MyComponent);
  app.mixin({
    /* My mixin */
  });
});

Troubleshooting

Storybook doesn't work with my Vue 2 project

Vue 2 entered End of Life (EOL) on December 31st, 2023, and is no longer maintained by the Vue team. As a result, Storybook no longer supports Vue 2. We recommend you upgrade your project to Vue 3, which Storybook fully supports. If that's not an option, you can still use Storybook with Vue 2 by installing the latest version of Storybook 7 with the following command:

<CodeSnippets paths={[ 'common/storybook-init-v7.npx.js.mdx', 'common/storybook-init-v7.yarn.js.mdx', 'common/storybook-init-v7.pnpm.js.mdx', ]} />

API

Options

You can pass an options object for additional configuration if needed:

// .storybook/main.ts
import type { StorybookConfig } from '@storybook/vue-webpack5';

const config: StorybookConfig = {
  framework: {
    name: '@storybook/vue-webpack5',
    options: {
      // ...
    },
  },
};

export default config;

builder

Type: Record<string, any>

Configure options for the framework's builder. For this framework, available options can be found in the Webpack builder docs.