>本文演示了故事书和色彩简化的反应组件图书馆开发,提供增强的文档,视觉回归测试以及改进的团队协作。
关键好处:>
为什么选择故事书?
对于工程师,产品经理和利益相关者来说,
> Web可访问性审核
故事书的设置和配置:
>
>安装:
最有效的方法是在项目的根目录中使用单个命令:
npx storybook@latest init
Storybook配置,主要通过进行处理,允许自定义文档演示文稿,通过附加组件甚至WebPack配置进行UI扩展。 打字稿是本地支持的,但是CSS体系结构需要单独的设置。请咨询样式和CSS文档以获取详细信息。
让我们创建一个示例创建React App:
main.js
>验证应用程序(使用
npx storybook@latest init
确认安装提示。 Storybook将在您的浏览器中启动。 将添加到项目中的.storybook
>文件夹(包含配置文件)和astories
文件夹(src
内)。 package.json
将包括新脚本:
npx create-react-app my-scalable-component-library
>使用npm run storybook
进行开发,npm run build-storybook
用于发布。该文件夹包含已发表的故事书。考虑将此文件夹添加到您的storybook-static
>。
在
.gitignore
键指定故事位置。 每个项目类型的main.js
键都会有所不同。
npx storybook@latest init
stories
>故事书附加组件:framework
docs
:原型的故事链接。
@storybook/addon-links
@storybook/addon-essentials
@storybook/preset-create-react-app
@storybook/addon-onboarding
@storybook/addon-interactions
然后,将其包含在>
"storybook": "storybook dev -p 6006", "build-storybook": "storybook build"
main.js
>
addons
一个故事通常代表组件及其变化。 它们是动态文件(React,Markdown或两者),接收参数(PROP)以生成变体。
让我们检查一个样本故事:
默认导出定义主组件和设置。 参数提供元数据。标签启用自动生成的文档。
定义参数行为。 默认值表示命名的导出代表变化,每个变化都与组件prop对齐。
Button
装饰师用其他背景包裹故事。 它们是在
/** @type { import('@storybook/react-webpack5').StorybookConfig } */ const config = { stories: ["../src/**/*.mdx", "../src/**/*.stories.@(js|jsx|mjs|ts|tsx)"], addons: [ "@storybook/addon-links", "@storybook/addon-essentials", "@storybook/preset-create-react-app", "@storybook/addon-onboarding", "@storybook/addon-interactions", ], framework: { name: "@storybook/react-webpack5", options: {}, }, docs: { autodocs: "tag", }, statistics: ["../public"], }; export default config;
argTypes
args
>发布您的故事书:decorators
生产构建(
>
>为VRT集成色彩:
在
npx storybook@latest init
>环境变量。 运行chromatic
将您的故事书发布到色彩。 对于CI/CD集成(推荐),请使用GitHub操作(请参阅色彩文档)。
package.json
npx create-react-app my-scalable-component-library
>
以上是用故事书和色素扩展您的React应用程序的详细内容。更多信息请关注PHP中文网其他相关文章!