给团队快速搭建一个面向vue的组件库

429 阅读2分钟

什么是组件库?

个人认为:包含组件的集合组件解析组件编译打包组件文档组件示例所组成的成套系统,可称作为组件库。

什么时候需要搭建团队自己的组件库?

  1. 第三方组件库已经不足以满足前端业务场景使用。
  2. 当对第三方组件有异议,或者出bug的时候,提issue需要等较长的反馈和迭代周期。
  3. 前端团队已经根据业务封装了多个业务组件。
  4. 前端项目规模已经达到一定程度,需要有专门的仓库维护组件代码,并且以文档方式输出。

rayx-ui

今天要介绍的也是个人开发的一套面向vue的组件库脚手架rayx-ui,开发者只需要按照文档规范开发组件、编写markdown、编写示例,然后执行命令即可生成文档,打包编译。

优点:

  1. 简单易上手,显著降低前端团队搭建组件库的门槛。
  2. 文档页面由vue开发,开发人员完全可以在里面自由改造布局,页面对应的组件数据完全由builder生成,和页面没有强关系。
  3. 快速组件分类,只需要在markdown中添加注释即可对组件进行分类。
  4. 快速生成props,methods说明

快速上手

克隆仓库

git clone https://github.com/WangXueZhi/rayx-ui.git

安装依赖

yarn 或者 npm i

按内置的模板创建组件

npm run create -- --name=compnent-name

组件命名规则,我们统一使用全小写命名组件,例如:button,如果是多单词命名,必须使用kebab-case(短横线分隔)的方式命名组件,比如 my-component, 使用命令创建可使用小驼峰、大驼峰、短横线任意一种方式,内部会转换成短横线的命名

注意:

  1. 如果只需要展示文档,在组件目录下编写markdown就行,其他文件可删除,该目录将不会作为组件进行打包,参考packages目录下的grid。
  2. 如果不需要展示文档,单纯增加组件,删除组件目录下的md文件即可,该组件将不会生成文档。

启动组件开发服务

yarn dev 或者 npm run dev

组件文档

开发文档

有搭建团队组件库的小伙伴快拿去试试吧,喜欢的话给个赞,给项目加颗星 github.com/WangXueZhi/…