Web components & Vite 版 Storybook

Web components & Vite 版 Storybook 是一个框架，可轻松为使用 Web components（使用 Vite 构建）的应用程序单独开发和测试 UI 组件。

要求

Vite ≥ 5.0

入门

在没有 Storybook 的项目中

在 Web components 项目的根目录中运行此命令后，请按照提示操作。

npm create storybook@latest

更多关于 Storybook 入门的信息。

在已有 Storybook 的项目中

此框架旨在与 Storybook 7+ 配合使用。如果您尚未升级到 v7，请使用此命令进行升级。

npx storybook@latest upgrade

自动迁移

运行上述 upgrade 命令时，您应该会看到一个提示，询问您是否要迁移到 @storybook/web-components-vite，它应该会为您处理所有事情。如果自动迁移不适用于您的项目，请参阅下面的手动迁移。

手动迁移

首先，安装框架。

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

然后，更新您的 .storybook/main.js|ts 以更改框架属性。

.storybook/main.ts

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

API

选项

如果需要，您可以传递一个选项对象进行其他配置

.storybook/main.ts

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

可用选项为

`builder`

类型：Record<string, any>

配置框架构建器的选项。对于此框架，可用选项可以在Vite 构建器文档中找到。