mint-ui 源码学习一 —— 项目整体分析

本文主要介绍 mint-ui 的目录结构、所有的技术栈以及组件库的搭建知识。

mint-ui 项目整体学习

项目目录

看图说话~

  • .github 目录用于规范一些 github 行为,其中存的都是些 md 文件。
  • build 目录用于构建组件库项目。其中使用了饿了么的 cooking 工具进行构建。
  • example 目录中是演示项目,用来演示组件库的使用。许多在官方文档中没有写全的东西都可以在这个目录下看到。这个演示项目的线上地址请看这里
  • lib 目录中是构建完成的打包 js 和 css 文件,这就是我们最终引用组件库的时候用到的文件。
  • node_modules 请忽略……
  • packages 目录下存放了组件库中的所有组件。在编译构建的时候入口文件会去 packages 目录下拿到所有组件。像这样import Button from '../packages/button';
  • src 目录下是组件库的一些通用代码了,也是入口文件所在。

组件库如何应用到 Vue 项目中?

组件库的安装其实就是使用了 Vue 的插件定义和使用的方式。可以看下 mint-ui 定义的插件公开方法 install

import Button from '../packages/button';
import Toast from '../packages/toast';
import Indicator from '../packages/indicator';
import MessageBox from '../packages/message-box';
import InfiniteScroll from '../packages/infinite-scroll';
import '../src/assets/font/iconfont.css'; // 字体样式

const version = '2.2.13';
const install = function(Vue, config = {}) {
  // 避免重复安装
  if (install.installed) return;
  // 注册组件
  Vue.component(Button.name, Button);
  // 使用插件
  Vue.use(InfiniteScroll);
  // 添加实例方法
  Vue.$messagebox = Vue.prototype.$messagebox = MessageBox;
  Vue.$toast = Vue.prototype.$toast = Toast;
  Vue.$indicator = Vue.prototype.$indicator = Indicator;
};

组件库的 install 方法一般就 3 种行为:

  1. 全局注册组件库
  2. 使用插件方法
  3. 添加全局实例方法

这也就是我们组件库中常用的功能了。

想看懂 mint-ui 源码需要知道什么技术栈?

  • JS 语法使用了 vue.js 框架(这想必大家都知道)。
  • 在 css 样式上使用的是 postcss-salad。它类似于 sass,常用的功能就是将一些类名进行包装了,如 @when plain 其实就是 .is-plain 选择器。

我在看组件库的时候在找 postcss-salad 上花了点时间。

如何搭建类似 mint-ui 的组件库?

其实市面上完善的通用组件库已有不少,像 Vue 方面的有 ElementUIVantMintUIiViewAntd 好像也出了 Vue 版本。所以,个人感觉重复造轮子无意义,但是以学习的态度去将一些常用到的业务组件抽离出来做一个组件库也是极好的提高生产效率的方式。
说说我搭建的个人组件库的过程:

  • 使用 vue-cli 搭建一个项目。
  • 参考主流组件库的目录结构搭建项目。其中比较好的全局方法完全可以挪用。
  • 写组件,写什么组件看自己需求。那些主流组件库的很多东西是很有借鉴和学习意义的。
  • 写完组件库之后使用 vue-cli 项目的构建命令构建出打包文件。
  • 最后配置 package.json 然后上传 npm(也可以不传 npm 直接 git 就可以导出项目),就这样大功告成。

mint-ui 的 src 目录下都有些什么,干啥用的?

  • assets 目录下是资源文件,存放了字体文件和加载中的 svg 图片。
  • mixins 目录下就一个 emitter.js 文件,作用是定义了父子组件间向上和向下的通信(之前 Vue 也有这个功能,后来取消了)。
  • style 目录下是一些全局的样式,其中 var.css 定义了全局的皮肤。可以实现快速换肤的功能。注: mint-ui 中所有的 css 都是用了 salad 来预编译,所以样式文件看着都怪怪的,像 sass 又不是 sass。
  • utils 目录中是一些通用的工具方法代码,这里面的工具很有参考价值,可以拿来使用。具体看看有啥:
    • popup 目录中是悬浮框的业务逻辑。
    • clickoutside.js 中定义了点击元素外触发的事件
    • dom.js 中处理一些与 dom 相关的方法。主要处理 dom 事件、dom 元素上的 class 和 style 的处理。
    • merge.js 方法用于将多个对象合并给目标对象并返回目标对象。
  • index.js 方法是组件库的入口文件,主要功能上面提到过了。主要做了几步:导入组件库所有组件和插件;使用 Vue 的插件定义方法将组件库变为 Vue 插件;在插件中注册组件、使用插件并添加实例方法;最后导出插件方法以及所有的单个组件。

相对于 element-ui 的 utils 目录,mint-ui 的 utils 目录真的是非常少的。不过其中的方法还是值得借鉴和学习的。

最后

文章内容较少,只是先起个头~
这个整体分析没太多讲的,大致了解下,也是自己整理下思路。为接下来一系列的文章做热身。
Vue 实验室之前有分析过一些 Element 的简单组件库,之后的 mint-ui 组件学习只会对博主感兴趣的、比较有意思的组件进行分析和学习。如有需求也可以评论留言哦。
其实能拥有一个私人组件库还是一件非常酷的事情啦让我们一起撸一个个人组件库

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,496评论 6 501
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,407评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,632评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,180评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,198评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,165评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,052评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,910评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,324评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,542评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,711评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,424评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,017评论 3 326
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,668评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,823评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,722评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,611评论 2 353

推荐阅读更多精彩内容