Skip to content

Commit 3326798

Browse files
docs(zh): translate use storybook (#554)
Co-authored-by: Timeless0911 <[email protected]>
1 parent 5316efc commit 3326798

File tree

2 files changed

+103
-5
lines changed

2 files changed

+103
-5
lines changed

website/docs/en/guide/advanced/storybook.mdx

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Using React as an example, at this step you need to:
2525

2626
1. Install the dependencies for Storybook Rsbuild React framework. The essential ones include
2727

28-
- [storybook](https://www.npmjs.com/package/@storybook/addon-essentials): The Storybook core.
28+
- [storybook](https://www.npmjs.com/package/storybook): The Storybook core.
2929
- [@storybook/addon-essentials](https://www.npmjs.com/package/@storybook/addon-essentials): a curated collection of addons to bring out the best of Storybook.
3030
- [@rsbuild/core](https://www.npmjs.com/package/@rsbuild/core): Storybook builder.
3131
- [storybook-addon-rslib](https://www.npmjs.com/package/storybook-addon-rslib): This addon will make Storybook Rsbuild could derive Rsbuild configuration from Rslib config file.
@@ -64,7 +64,7 @@ Using React as an example, at this step you need to:
6464
};
6565
```
6666

67-
3. Add a simple story to the `stories` directory. For example, create a `Button.stories.js` file with the following content:
67+
3. Add a simple story to the `stories` directory. For example, create a `Button.stories.js` file with the following content:
6868

6969
```js title="stories/Button.stories.js"
7070
import { Button } from '../src/Button';
@@ -97,9 +97,6 @@ npx storybook build // build static files
9797

9898
Check out more details in the [Storybook Rsbuild documentation](https://storybook.rsbuild.dev/) and the [Storybook documentation](https://storybook.js.org/docs/react/get-started/introduction).
9999

100-
{/* TODO: */}
101-
{/* ## Module Federation */}
102-
103100
## Example
104101

105102
- [React component library + Rslib + Storybook](https://github.com/rspack-contrib/storybook-rsbuild/tree/main/sandboxes/rslib-react-component)
Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,102 @@
1+
import { PackageManagerTabs } from '@theme';
2+
import { Tab, Tabs } from 'rspress/theme';
3+
14
# 使用 Storybook
5+
6+
[Storybook](https://storybook.js.org/) 是一个为 React、Vue 等框架独立开发 UI 组件的强大的工具,它能够独立构建和测试组件,从而提升开发和测试效率。
7+
8+
[storybook-rsbuild](https://github.com/rspack-contrib/storybook-rsbuild) 是 Rsbuild 支持的 Storybook 构建器,并集成了 React、Vue 3 框架和原生 JavaScript。统一使用 Rsbuild 构建系统可以使 Storybook 与 Rslib 使用统一的构建配置。
9+
10+
:::tip
11+
你可以通过 [create-rslib](/guide/start/quick-start#创建一个 Rslib 项目) 创建一个新项目。
12+
:::
13+
14+
## 快速开始
15+
16+
### 创建一个 Rslib 项目
17+
18+
这是设置 Storybook 的前提条件。你需要有一个包含组件的 Rslib 项目,并希望在 Storybook 中展示这些组件,请查看 [解决方案](/guide/solution/) 以设置 Rslib 项目。
19+
20+
### 将 Storybook 添加到项目中
21+
22+
使用现有的 Rslib 项目设置 Storybook。为了使用 React、Vue 3、原生 JavaScript 或其他框架,必须首先安装适当的 Storybook 框架包。有关安装说明,可以查阅 [Storybook Rsbuild 文档](https://storybook.rsbuild.dev/guide/framework.html)
23+
24+
以 React 为例,在这一步你需要:
25+
26+
1. 安装 Storybook Rsbuild React 框架的依赖。必要的依赖包括
27+
28+
- [storybook](https://www.npmjs.com/package/storybook):Storybook core 包。
29+
- [@storybook/addon-essentials](https://www.npmjs.com/package/@storybook/addon-essentials):精选的插件集合,以充分发挥 Storybook 的作用。
30+
- [@rsbuild/core](https://www.npmjs.com/package/@rsbuild/core):Storybook 构建器。
31+
- [storybook-addon-rslib](https://www.npmjs.com/package/storybook-addon-rslib):此插件将使 Storybook Rsbuild 能够从 Rslib 配置文件中继承 Rsbuild 配置。
32+
该插件将自动读取 Rslib 配置并将其应用于 Storybook Rsbuild,确保配置统一。你可以查看 [storybook-addon-rslib](https://storybook.rsbuild.dev/guide/integrations/rslib.html) 文档以了解可用选项。
33+
34+
<PackageManagerTabs
35+
command={{
36+
npm: 'npm add storybook @storybook/addon-essentials storybook-addon-rslib @rsbuild/core -D',
37+
yarn: 'yarn add storybook @storybook/addon-essentials storybook-addon-rslib @rsbuild/core -D',
38+
pnpm: 'pnpm add storybook @storybook/addon-essentials storybook-addon-rslib @rsbuild/core -D',
39+
bun: 'bun add storybook @storybook/addon-essentials storybook-addon-rslib @rsbuild/core -D',
40+
}}
41+
/>
42+
43+
每个框架的依赖各不相同,可查阅 [Storybook Rsbuild 文档](https://storybook.rsbuild.dev/guide/framework.html) 了解详细信息。在这个 React 示例中,我们将安装 [storybook-react-rsbuild](https://www.npmjs.com/package/storybook-react-rsbuild) 作为框架集成。
44+
45+
<Tabs>
46+
<Tab label="React">
47+
<PackageManagerTabs command="add storybook-react-rsbuild -D" />
48+
</Tab>
49+
<Tab label="Vue">
50+
<PackageManagerTabs command="add storybook-vue3-rsbuild -D" />
51+
</Tab>
52+
</Tabs>
53+
54+
2. 配置 Storybook 配置文件 `.storybook/main.js`,指定 stories 和 addons,并使用相应的框架集成设置框架。
55+
56+
```js title=".storybook/main.js"
57+
export default {
58+
stories: [
59+
'../stories/**/*.mdx',
60+
'../stories/**/*.stories.@(js|jsx|mjs|ts|tsx)',
61+
],
62+
addons: ['@storybook/addon-essentials', 'storybook-addon-rslib'],
63+
framework: 'storybook-react-rsbuild', // 例如 storybook-react-rsbuild
64+
};
65+
```
66+
67+
3.`stories` 目录添加一个简单的 story。例如,创建一个 `Button.stories.js` 文件,内容如下:
68+
69+
```js title="stories/Button.stories.js"
70+
import { Button } from '../src/Button';
71+
72+
const meta = {
73+
title: 'Example/Button',
74+
component: Button,
75+
};
76+
77+
export default meta;
78+
79+
export const Primary = {
80+
args: {
81+
primary: true,
82+
label: 'Button',
83+
},
84+
};
85+
```
86+
87+
:::tip
88+
如果你使用的是 [Yarn Plug-n-Play](https://yarnpkg.com/features/pnp) 或者你的项目是在 monorepo 环境中设置的,你可能会遇到模块解析问题。在这种情况下,你可以添加一个 `getAbsolutePath('storybook-addon-rslib')` 函数来解析插件。有关更多信息,请查看 [Storybook 的 FAQ](https://storybook.js.org/docs/faq#how-do-i-fix-module-resolution-in-special-environments)
89+
:::
90+
91+
大功告成,你可以使用以下命令启动和构建 Storybook 服务器:
92+
93+
```bash
94+
npx storybook dev // 开发模式
95+
npx storybook build // 构建静态文件
96+
```
97+
98+
查看 [Storybook Rsbuild 文档](https://storybook.rsbuild.dev/)[Storybook 文档](https://storybook.js.org/docs/react/get-started/introduction) 以了解更多信息。
99+
100+
## 示例
101+
102+
- [React 组件库 + Rslib + Storybook](https://github.com/rspack-contrib/storybook-rsbuild/tree/main/sandboxes/rslib-react-component)

0 commit comments

Comments
 (0)