每个前端都值得拥有自己的组件库,就像每个冬天都拥有春秋裤⛄️

简介: 每个前端都值得拥有自己的组件库,就像每个冬天都拥有春秋裤⛄️

image.png

大家好,我是速冻鱼🐟,一条水系前端💦,喜欢花里胡哨💐,持续沙雕🌲,是隔壁寒草🌿的好兄弟。 欢迎小伙伴们加我微信:sudongyuer拉你进群,一起讨论,期待与大家共同成长🥂。


阅读本文📖



1.您将了解到如何超快速0-1搭建并上线一个组件库🦑

2.您将了解到什么是storybook🦧

3.您将了解到如何使用storybook搭建组件库 🦓

4.您将了解到如何使用Chromatic部署我们的组件库🦩

3.您将了解到如何使用GitHub Action完成CI操作🐇

本文GitHub仓库地址:taskbox

组件库在线地址:taskbox


前言🌵


为什要造前端组件库呢,更多的是抽离业务组件,实现复用,但是往往现实是残酷的,一个优秀的组件库是非常庞大就具有难度的,但是通过这篇文章我们还是能从开发到上线完成一个简单的组件库,让你了解整个流程


什么是StoryBook🐇




image.png

Storybook是一个UI组件开发环境。它允许你浏览组件库,并查看每个组件的不同状态,并交互地开发和测试组件,非常简单快捷,而且很多公司在使用,而且你可以开发不同技术栈的组件库,相当方便,而且拥有一套成熟的CIDI方案

用我的话来说就是Storybook是一个可以让你专注于编写组件,而无需去关注文档的一个强大的组件开发环境,想试验,或者尝试组件开发的小伙伴都可以值得一试,成本极低,可以快速上线。

Storybook 提供了一个沙箱来独立构建 UI,因此您可以开发难以到达的状态和边缘情况。

image.png

强大的CIDI


image.png

开发步骤~⭐


初始化Storybook(Rect组件库为例)☄️

# Create our application:
npx create-react-app taskbox
cd taskbox
# Add Storybook:
npx -p @storybook/cli sb init

介绍目录结构🌞


  • .storybook/main.js相当于我们组件库的入口


image.png

  • stories表示我们的组件所在目录,Storybook会将这个数组目录下的文件加载到我们看见的组件库Index首页
  • addons表示我们使用到的插件


image.png

开始编写一个简单的组件🌻


将我们的组件写在刚刚配置好的stories数组中的任一目录即可

image.png

以最常见的Button组件为例子

image.png

Button.jsx


image.png


button.css


image.png

Button.stories.jsx


使用Butto.stories.jsx作为我们组件的载体,这样Storybook就能很好的生成组件相关文档,将组件展示在页面中


image.png


使用 export 导出不同状态的Button组件,这样组件就算写好了


看看效果😊


image.png


部署我们的组件库💥


1.创建远程Github仓库并push代码⚡️



image.png


2.为项目安装Storybook强大的工具链工具Chromatic✨


yarn add -D chromatic

3.去Chromatic网站关联我们github组件库项目🌼


什么是Chromatic呢?


Chromatic 是一个基于云的工具链,用于 Storybook这有助于团队更快地发布 UI 组件,使用它我们可以超快的完成CIDI,而且还可以很方便的管理我们的组件库项目,可以去官网了解更多www.hellogithub.com/


image.png

4.部署上线🌸


关联好项目后,我们会得到一个token

使用这个token执行以下命令就能很好的构建并部署我们的Storybook

yarn chromatic --project-token=<project-token>
复制代码


image.png

5.获得项目URL🌴


在执行完上面的构建命令后,我们就会在命令行得到一个URL,这个URL就是我们的组件库部署之后的在线地址,这样你就可以把你的这个链接分享给你同事,或者朋友,让他们看看你的组件库啦!!!👍


6.添加 GitHub Action 部署 Storybook🌲


现在我们的项目托管在 Github 仓库,我们能够使用持续集成 CI 服务完成 Storybook 自动化部署。GitHub Actions 是一个免费的 CI 服务,内置在 Github 中,轻松实现自动发布。

在项目根文件夹下创建一个新目录命名为 .github 并在其中创建另一个 workflows 目录。

image.png

像下面的一样,创建一个新文件命名为 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


image.png

并且可以查看本次提交修改了什么代码,能不能合并,很多功能,这里就不一一讲解了,大家感兴趣可以自己去探索一下


image.png

总结 🍁


🌈这就样我们的组件库终于从零到编写一个Button组件,从构建到发布,再通过GitHub ActionStorybook以及Chromatic的梦幻联动实现了方便的持续集成。当然这篇短文只是帮助大家有个全面的认识,要想开发一个优秀的组件库是非常难的,要涉及很多东西,从代码规范各种插件再到测试都是需要花费很多精力的,但是有了Storybook可以让我们很快的搭建起来属于我们自己的组件库,希望每个小伙伴都能有所收获,去编写一个属于自己风格组件库吧🍄。


源代码仓库地址:taskbox👣


组件库在线地址:taskbox




相关文章
|
14天前
|
前端开发 JavaScript
前端项目公共组件封装思想
该文介绍了如何封装通用组件,如表单搜索、表格展示和分页器。首先,通过抽离出公共部分,创建`TableContainer`组件,利用具名插槽插入`navbar`和`table`,并通过props传递标题。然后在父组件中使用具名插槽和子组件实现具体功能。文中还展示了更复杂的组件封装示例,通过props实现数据双向绑定,以`el-pagination`为例,利用`sync`修饰符和`computed`属性监听并更新父组件状态,实现分页功能。文章最后提到了内容来源于哪。
|
20天前
|
移动开发 前端开发 JavaScript
前端高效开发JavaScript库!
前端高效开发JavaScript库!
|
6天前
|
JavaScript 前端开发 API
【前端--Vue】组件之间的多种通信方式,一文彻底搞懂组件通信!
【前端--Vue】组件之间的多种通信方式,一文彻底搞懂组件通信!
【前端--Vue】组件之间的多种通信方式,一文彻底搞懂组件通信!
|
6天前
|
资源调度 JavaScript 前端开发
【前端开发---Vue2】史上最详细的Vue入门教程(六) --- 工程化开发和脚手架、组件注册
【前端开发---Vue2】史上最详细的Vue入门教程(六) --- 工程化开发和脚手架、组件注册
【前端开发---Vue2】史上最详细的Vue入门教程(六) --- 工程化开发和脚手架、组件注册
|
13天前
|
前端开发 网络架构
1天搞定SpringBoot+Vue全栈开发 (8)前端路由VueRouter(进行组件切换)
1天搞定SpringBoot+Vue全栈开发 (8)前端路由VueRouter(进行组件切换)
|
21天前
|
前端开发 JavaScript Java
浅谈企业级前端应用中的组件概念和具体的应用
浅谈企业级前端应用中的组件概念和具体的应用
21 1
|
22天前
|
移动开发 前端开发
ruoyi-nbcio-plus的Vue3前端升级组件后出现的问题(二)
ruoyi-nbcio-plus的Vue3前端升级组件后出现的问题(二)
26 1
|
22天前
|
移动开发 前端开发 JavaScript
ruoyi-nbcio-plus的Vue3前端升级组件后出现的问题(一)
ruoyi-nbcio-plus的Vue3前端升级组件后出现的问题(一)
24 2
|
22天前
|
前端开发
前端进度条组件NProgress
前端进度条组件NProgress
24 1
前端进度条组件NProgress
|
22天前
|
前端开发 搜索推荐 UED
【Flutter前端技术开发专栏】Flutter中的高级UI组件应用
【4月更文挑战第30天】探索Flutter的高级UI组件,如`TabBar`、`Drawer`、`BottomSheet`,提升应用体验和美观度。使用高级组件能节省开发时间,提供内置交互逻辑和优秀视觉效果。示例代码展示了如何实现底部导航栏、侧边导航和底部弹出菜单。同时,自定义组件允许个性化设计和功能扩展,但也带来性能优化和维护挑战。参考Flutter官方文档和教程,深入学习并有效利用这些组件。
【Flutter前端技术开发专栏】Flutter中的高级UI组件应用