Storybook for Web components & Vite

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

Getting started

In a project without Storybook

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

npm create storybook@latest

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:

npx storybook@latest upgrade

When running the upgrade command above, you should get a prompt asking you to migrate to @storybook/web-components-vite, 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:

npm install --save-dev @storybook/web-components-vite

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

.storybook/main.ts

import { StorybookConfig } from '@storybook/web-components-vite';
 
const config: StorybookConfig = {
  // ...
  framework: '@storybook/web-components-vite', // 👈 Add this
};
 
export default config;

API

Options

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

.storybook/main.ts

import type { StorybookConfig } from '@storybook/web-components-vite';
 
const config: StorybookConfig = {
  framework: {
    name: '@storybook/web-components-vite',
    options: {
      // ...
    },
  },
};
 
export default config;

The available options are:

`builder`

Type: Record<string, any>

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