项目简介
本项目是基于 React 和 Storybook 的学习仓库,旨在通过实践让开发者掌握 Storybook 的使用方法与技巧。利用该项目可轻松创建、编辑和运行 React 组件的不同版本,便于开展组件开发与测试工作。
项目的主要特性和功能
- 支持通过 CLI 或手动集成方式初始化 Storybook,配置选项灵活。
- 集成行动和链接插件,用于展示事件交互与实现 Storybook 内页面跳转。
- 能自动导入所有以
.stories.js
结尾的文件,方便管理和组织故事。 - 可通过添加 storysource 等额外插件展示故事的源代码。
安装使用步骤
假设用户已下载本项目的源码文件:
1. 安装依赖:进入项目目录,执行 npm install
命令安装所有依赖。
2. 初始化 Storybook:执行 npm run storybook
命令启动 Storybook。
3. 配置基本设置:在 .storybook
文件夹下创建或修改 config.js
文件。
4. 编写故事:在 src/stories
文件夹下创建故事文件(如 demo.stories.js
),编写和组织故事内容。
5. 运行与测试:运行 Storybook,查看并测试组件。
关于插件的使用说明
- 行动(actions)插件:用于记录用户在故事中的点击、交互等行动,并展示在 Storybook 的控制台中。通过引入
@storybook/addon-actions
并使用action
函数来定义行动。 - 链接(links)插件:允许在故事之间进行跳转。通过引入
@storybook/addon-links
并使用linkTo
函数来实现页面跳转。 - storysource 插件:展示故事的源代码。通过引入
@storybook/addon-storysource
并在 webpack 配置中添加相应的 loader 来实现。
下载地址
点击下载 【提取码: 4003】【解压密码: www.makuang.net】