{T}

快速掌握Storybook

学习目标

  • 理解并掌握 快速掌握Storybook 的核心原理与工程实践

总结

写组件文档,我们一般都是用 Storybook。

它把不同 props 的渲染结果叫做一个 story,一个组件有多个 story。

story 可以通过 args 指定传入组件的参数,通过 loaders 请求数据,通过 render 函数自定义渲染内容、通过 play 指定自动执行的脚本等。

而且还可以渲染完组件直接跑测试用例,就很方便。

storybook 还会自动生成组件文档,而且也可以把项目里的 mdx 文件加到文档里。

用起来也很简单,首先 npx storybook init 初始化,之后执行 npm run storybook 就可以了。

总之,用 storybook 可以轻松的创建组件文档,可以写多个 story,直观的看到组件不同场景下的渲染结果,还可以用来做测试。

如果想给你的组件加上文档,storybook 基本是最好的选择。

继续阅读