Storybook for Preact & Vite

Storybook for Preact & Vite 是一个框架，用于轻松地独立开发和测试使用Vite 构建的 Preact 应用的 UI 组件。它包括

🏎️ 预打包以提升性能
🪄 零配置
💫 等等！

要求

Preact 8.x || 10.x
Vite ≥ 5.0

入门

在没有 Storybook 的项目中

在你的 Preact 项目根目录中运行此命令后，按照提示操作

npm create storybook@latest

更多关于 Storybook 入门的信息。

在已安装 Storybook 的项目中

此框架设计用于 Storybook 7+ 版本。如果你尚未使用 v7，请运行此命令进行升级

npx storybook@next upgrade

自动迁移

运行上述 upgrade 命令时，你应该会收到一个提示，询问是否迁移到 @storybook/preact-vite，这应该会为你处理所有事情。如果自动迁移不适用于你的项目，请参考下面的手动迁移说明。

手动迁移

首先，安装框架

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

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

.storybook/main.ts

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

API

选项

如果需要，你可以传入一个 options 对象进行额外配置

.storybook/main.ts

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

`builder`

类型：Record<string, any>

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