每个前端都值得拥有自己的组件库
1.您将了解到如何超快速0-1搭建并上线一个组件库🦑
2.您将了解到什么是storybook🦧
3.您将了解到如何使用storybook搭建组件库 🦓
4.您将了解到如何使用Chromatic部署我们的组件库🦩
3.您将了解到如何使用GitHub Action完成CI操作🐇
本文GitHub仓库地址:taskbox[2]
组件库在线地址:taskbox[3]
前言🌵什么是StoryBook🐇为什要造前端组件库呢,更多的是抽离业务组件,实现复用,但是往往现实是残酷的,一个优秀的组件库是非常庞大就具有难度的,但是通过这篇文章我们还是能从开发到上线完成一个简单的组件库,让你了解整个流程
![00ac2a9ba1de648c909449c097063af4.webp](https://filescdn.proginn.com/0ef94f544feaac4c880b8363ec932100/00ac2a9ba1de648c909449c097063af4.webp)
Storybook是一个UI组件
的开发环境
。它允许你浏览组件库,并查看每个组件的不同状态,并交互地开发和测试组件,非常简单快捷,而且很多公司在使用,而且你可以开发不同技术栈的组件库,相当方便,而且拥有一套成熟的CIDI
方案
用我的话来说就是Storybook是一个可以让你专注于编写组件,而无需去关注文档的一个强大的组件开发环境,想试验,或者尝试组件开发的小伙伴都可以值得一试,成本极低,可以快速上线。
Storybook 提供了一个沙箱
来独立构建 UI,因此您可以开发难以到达的状态和边缘情况。
![e63fe425524af7cc3c3034af4d85ec61.webp](https://filescdn.proginn.com/182565237c35eceb39d342f7c701282a/e63fe425524af7cc3c3034af4d85ec61.webp)
强大的CIDI
![8c814a0ee3e0dbe418eb2279a8873478.webp](https://filescdn.proginn.com/4b8ff0a46d14840ab38a436202b358c2/8c814a0ee3e0dbe418eb2279a8873478.webp)
初始化Storybook(Rect组件库为例)☄️
# Create our application:
npx create-react-app taskbox
cd taskbox
# Add Storybook:
npx -p @storybook/cli sb init
复制代码
介绍目录结构🌞
.storybook/main.js
相当于我们组件库的入口
![0063e79488b4451921c15a179972ae2f.webp](https://filescdn.proginn.com/3ded4e97770cf214c064c1dde9f357bb/0063e79488b4451921c15a179972ae2f.webp)
stories
表示我们的组件所在目录,Storybook会将这个数组目录下的文件加载到我们看见的组件库Index首页addons
表示我们使用到的插件
![246dff6e4721ae078f8335abe3130540.webp](https://filescdn.proginn.com/c514a65a99629ec58ff0b7d6b22162ac/246dff6e4721ae078f8335abe3130540.webp)
开始编写一个简单的组件🌻
将我们的组件写在刚刚配置好的
stories
数组中的任一目录即可
![45c4759d4c9f17a94061a1e009656026.webp](https://filescdn.proginn.com/39c85aaa95d25402c08c88862a3d1164/45c4759d4c9f17a94061a1e009656026.webp)
以最常见的Button
组件为例子
![728d7cd0aa6d374c7a3f3a8402f2743a.webp](https://filescdn.proginn.com/b3dd6938deb77163ada4766626859e0a/728d7cd0aa6d374c7a3f3a8402f2743a.webp)
Button.jsx
![3d4502244732137492c8faf31d96a075.webp](https://filescdn.proginn.com/568b059fa4f0d33f08a55c345e66ee31/3d4502244732137492c8faf31d96a075.webp)
button.css
![caaed42647a680fd1ec18fba7087c440.webp](https://filescdn.proginn.com/9ec36cf6aa47162a2c42eff172b0cb49/caaed42647a680fd1ec18fba7087c440.webp)
Button.stories.jsx
使用Butto.stories.jsx
作为我们组件的载体,这样Storybook
就能很好的生成组件相关文档
,将组件展示在页面中
![a79fb2e6e42a3037a66367b0fc63b52c.webp](https://filescdn.proginn.com/3ee28dd43dc84dd064fd21071de20ca9/a79fb2e6e42a3037a66367b0fc63b52c.webp)
使用 export 导出不同状态的Button组件,这样组件就算写好了
看看效果😊
![02b226707052d144d06280f373575837.webp](https://filescdn.proginn.com/1e77886115e56347bfda625fd0221a0f/02b226707052d144d06280f373575837.webp)
部署我们的组件库💥
1.创建远程Github仓库并push代码⚡️
![3cb68c9e04dcf958d4b03af8401331b3.webp](https://filescdn.proginn.com/f3d61fe8fe46c3ac2c1f90e0e6c81bf1/3cb68c9e04dcf958d4b03af8401331b3.webp)
2.为项目安装Storybook强大的工具链工具Chromatic✨
yarn add -D chromatic
复制代码
3.去Chromatic[4]网站关联我们github组件库项目🌼
什么是Chromatic
呢?
Chromatic
是一个基于云的工具链,用于 Storybook[5]这有助于团队更快地发布 UI 组件,使用它我们可以超快的完成CIDI,而且还可以很方便的管理我们的组件库项目,可以去官网了解更多www.hellogithub.com/[6]
![ab9aff67bbca7eea4d610192e6eac9f0.webp](https://filescdn.proginn.com/28eafa3351a017adf0ba93f03b59c5e3/ab9aff67bbca7eea4d610192e6eac9f0.webp)
4.部署上线🌸
关联好项目后,我们会得到一个token
使用这个token
执行以下命令就能很好的构建并部署
我们的Storybook
yarn chromatic --project-token=
复制代码
![5952037f26725a64daf63294625b6fec.webp](https://filescdn.proginn.com/eb3177b3ed503fac30e9d6b2fd2be7e7/5952037f26725a64daf63294625b6fec.webp)
5.获得项目URL🌴
在执行完上面的构建命令后,我们就会在命令行得到一个URL,这个URL就是我们的组件库部署
之后的在线地址
,这样你就可以把你的这个链接
分享给你同事,或者朋友,让他们看看你的组件库啦!!!👍
6.添加 GitHub Action 部署 Storybook🌲
现在我们的项目托管在 Github 仓库,我们能够使用持续集成 CI 服务完成 Storybook 自动化部署。GitHub Actions[7] 是一个免费的 CI 服务,内置在 Github 中,轻松实现自动发布。
在项目根文件夹下创建一个新目录命名为 .github
并在其中创建另一个 workflows
目录。
![a70956478c15cd4eada56d400764d774.webp](https://filescdn.proginn.com/6c5199135c1ef4b6a1e431908eb91ac5/a70956478c15cd4eada56d400764d774.webp)
像下面的一样,创建一个新文件命名为 chromatic.yml
。将 project-token
替换为你项目的 project token
。
chromatic.yml
# .github/workflows/chromatic.yml
# Workflow name
name: 'Chromatic Deployment'
# Event for the workflow
on: push
# List of jobs
jobs:
test:
# Operating System
runs-on: ubuntu-latest
# Job steps
steps:
- uses: actions/checkout@v1
- run: yarn
#👇 Adds Chromatic as a step in the workflow
- uses: chromaui/action@v1
# Options required for Chromatic's GitHub Action
with:
#👇 Chromatic projectToken, see https://storybook.js.org/tutorials/intro-to-storybook/react/en/deploy/ to obtain it
projectToken: ${{ XXXXXXXX }}
token: ${{ secrets.GITHUB_TOKEN }}
复制代码
然后提交我们本次修改到远程仓库就行了,设置了GitHub action
后,当推送代码时,你的 Storybook
将部署到 Chromatic
上。你可以在 Chromatic 的构建屏幕中找到所有已发布的 Storybook
。
![7ff9547fe4c707b2475ea38d4bebbf3c.webp](https://filescdn.proginn.com/423d640ce4d3fe5897b2e66f6b9102c5/7ff9547fe4c707b2475ea38d4bebbf3c.webp)
并且可以查看本次提交修改了什么代码,能不能合并,很多功能,这里就不一一讲解了,大家感兴趣可以自己去探索一下
![1f3c7bd8a244ff25ed8bb621346a71ec.webp](https://filescdn.proginn.com/3362c27f0d4cfcc584c567628ecb90fc/1f3c7bd8a244ff25ed8bb621346a71ec.webp)
🌈这就样我们的组件库终于从零到编写一个Button
组件,从构建到发布,再通过GitHub Action
和Storybook
以及Chromatic
的梦幻联动实现了方便的持续集成。当然这篇短文只是帮助大家有个全面的认识,要想开发一个优秀的组件库是非常难的,要涉及很多东西,从代码规范
到各种插件
再到测试
都是需要花费很多精力的,但是有了Storybook
可以让我们很快的搭建起来属于我们自己的组件库,希望每个小伙伴都能有所收获,去编写一个属于自己风格
的组件库
吧🍄。
源代码仓库地址:taskbox[8]👣
组件库在线地址:taskbox[9]
结束语🦚![9d91a6ac4dd3e0846853c6f601ee2f10.webp](https://filescdn.proginn.com/bfa6053e3d116d989d1bf97dfa927fe4/9d91a6ac4dd3e0846853c6f601ee2f10.webp)
那么我的每个前端都值得拥有自己的组件库,就像每个冬天都拥有秋裤⛄️
这篇文章结束了,每个前端都值得拥有自己的组件库,希望这个冬天你不缺秋裤穿😂,文章的目的其实很简单就是对日常工作的总结和输出,不管菜不菜输出总是有意义的,也希望通过文章认识更多志同道合的朋友,如果你也喜欢折腾,欢迎加我好友,一起沙雕,一起进步。
关于本文
来源:速冻鱼https://juejin.cn/post/7030570376329429022