close
  • 简体中文
  • 快速上手

    Storybook Rsbuild

    latest versionNPM downloads per monthlicense

    Storybook 版本

    main 分支提供面向 Storybook v10 的 Rsbuild builder 以及各 framework 集成。请使用下表匹配你的 Storybook 版本,并在升级到 v10 前阅读官方迁移指南

    StorybookStorybook Rsbuild
    v10^3.0.0
    v9^2.0.0
    v8^1.0.0

    Storybook Rsbuild 让你能够使用 Rsbuild 作为 Storybook 的构建引擎,从而获得更快的启动和构建速度。

    在使用 AI 编程助手?

    如果你使用 Claude CodeCodexOpenCode 或其他 AI 编程助手,可以安装我们的 agent skills 以获得引导式的安装与迁移:

    npm
    yarn
    pnpm
    bun
    deno
    npx skills add rstackjs/agent-skills --skill storybook-rsbuild

    这些 skills 会教你的 agent 如何配置 rsbuildFinal、设置 framework 集成,以及从 webpack/Vite 迁移。

    快速开始

    最快的上手方式是使用 Storybook CLI。

    新项目

    如果你正在搭建一个新项目,我们推荐先创建一个 Rsbuild 项目,然后再添加 Storybook。

    # 1. Create a new Rsbuild project
    npm create rsbuild@latest
    
    # 2. Initialize Storybook (in the project root)
    npx storybook@latest init

    Storybook 会检测到 Rsbuild 并自动为你配置 storybook-builder-rsbuild,同时还会向你的项目添加示例 stories。若想了解生成的文件,请查看 Storybook 项目结构

    已有项目

    如果你正在将一个已有的 Storybook 项目迁移到 Rsbuild,请安装相应的 framework 包并更新你的 .storybook/main.ts

    详细的迁移指南请参阅 Frameworks 章节。

    Package提供的能力
    storybook-builder-rsbuild由 Rsbuild 驱动的 Storybook builder
    storybook-react-rsbuild为 Rsbuild 配置的 React framework 集成
    storybook-vue3-rsbuild为 Rsbuild 配置的 Vue 3 framework 集成
    storybook-html-rsbuild原生 JavaScript/TypeScript 集成
    storybook-web-components-rsbuildLit 与 Web Components 集成
    storybook-addon-rslib在 Storybook 中复用 Rslib 配置的 addon
    storybook-addon-modernjs在 Storybook 中复用 Modern.js 配置的 addon

    使用

    Peer dependency 要求
    • @rsbuild/core >= 1.0.1 — Storybook Rsbuild 依赖稳定的 Rsbuild 1.0 运行时。背景信息请参阅 1.0 发布公告
    • storybook >= 10.0.0 — 这些包已针对 Storybook 10 验证。升级指引可参阅 Storybook 发布说明

    使用 v8 兼容版本的包时,你无需直接安装 storybook-builder-rsbuildstorybook-react-rsbuildstorybook-vue3-rsbuild 等 framework 包已经为你内置了它。

    使用下列 framework 指南将 Storybook Rsbuild 接入你的项目。

    与 framework 一起使用

    React

    参见集成 React

    Vue

    参见集成 Vue

    原生 JS/TS

    参见集成原生 JavaScript / TypeScript

    Web components

    参见集成 web components(Lit)

    集成

    与 Modern.js

    在 Storybook 中复用你已有的 Modern.js 配置。

    参见集成 Modern.js

    与 Rslib

    在 Storybook 中复用你已有的 Rslib 配置。

    参见集成 Rslib

    与 Rspack

    将 Storybook Rsbuild 连接到已有的 Rspack 配置。

    参见集成 Rspack