用于 React & Vite 的 Storybook

用于 React & Vite 的 Storybook 是一个框架，可以轻松地为使用 React 和 Vite 构建的应用程序隔离开发和测试 UI 组件。它包括

🏎️ 预捆绑以提高性能
🪄 零配置
💫 以及更多！

要求

React ≥ 16.8
Vite ≥ 4.0
Storybook ≥ 8.0

开始上手

在没有 Storybook 的项目中

在 React 项目的根目录下运行此命令后，按照提示操作

npm create storybook@latest

更多关于 Storybook 入门的信息。

在已有 Storybook 的项目中

此框架旨在与 Storybook 7+ 版本配合使用。如果你尚未使用 v7，请使用以下命令升级

npx storybook@latest upgrade

自动迁移

运行上面的 upgrade 命令时，你应该会收到提示，要求你迁移到 @storybook/react-vite，它应该为你处理一切。如果自动迁移不适用于你的项目，请参考下面的手动迁移。

手动迁移

首先，安装框架

npm install --save-dev @storybook/react-vite

然后，更新你的 .storybook/main.js|ts 以更改 framework 属性

.storybook/main.ts

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

运行设置向导

如果一切顺利，你应该会看到一个设置向导，它将帮助你开始使用 Storybook，向你介绍主要概念和功能，包括 UI 的组织方式、如何编写你的第一个 story，以及如何利用 controls 测试组件对各种输入的响应。

Storybook onboarding

如果你跳过了向导，你可以随时通过将 ?path=/onboarding 查询参数添加到你的 Storybook 实例的 URL 中来再次运行它，前提是示例 stories 仍然可用。

API

选项

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

.storybook/main.ts

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

`builder`

类型: Record<string, any>

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