ElementUI 源码分析2 - 组件篇

ElementUI 是一套为开发者、设计师和产品经理准备的基于 Vue 2.0 的桌面端组件库。

0、前言

老规矩,带着问题看源码:

  • 组件的两种使用方式是如何做的(Tag模式|API 模式)?
  • scss 文件是如何优雅组织的 ?

1、组件分析

3.1、基本结构

组件的共性分析:
1、结构都是类似的,以Alert为例:

import Alert from './src/main';  // 单文件组件
/* istanbul ignore next */
Alert.install = function(Vue) {
  Vue.component(Alert.name, Alert);
};
export default Alert;

这样写的目的在于提供两种方式使用 Alert:

import {Alert} from 'element-ui'
// 方式1:直接使用(每次使用的时候都需要import)
<alert>
// 方式2:注册成全局组件(每次使用的时候不需要import)
Vue.use(Alert)

2、单文件组件的结构
i、只写template和script部分,style部分单独在 theme-chalk 下,在使用按需加载组件时,会配合 babel-plugin-component 插件将style部分引入

{
  "presets": [["es2015", { "modules": false }]],
  "plugins": [
    [
      "component",
      {
        "libraryName": "element-ui",
        "styleLibraryName": "theme-chalk"
      }
    ]
  ]
}

ii、template 部分大都以 transition 组件包裹,其name属性指定过渡动画,过渡动画的css代码单独抽出在 theme-chalk/src/common/transition.scss,联合 icon.scss 组成两个所有组件都依赖的公共css文件。template中固定类名写在 class 上,动态类名写在 :class 上,且类名都以 computed 方式通过JS代码提供
iii、template 中较多地方使用 slot 实现内容的动态化
iiii、通过 this.$emit() 的方式向外部触发事件

3.2 组件实现分析

组件数量较多,这里仅做简要分析,详细分析请看 Element非官方分析

  • alert
    和 message-box 中的 alert 区别在于只能以组件的形式调用,不能以 this.$alert 方式调用
  • aside
    对 html5 中的 aside 标签使用默认 slot 进行了一次封装
  • autocomplete
v-bind="[$props,$attrs]"  // 这种写法可以将父组件的所有props和attrs绑定到子组件

指令v-clickoutside 的实现原理:将使用了该指令的组件收集到一个数组nodeList ,然后监听document 的 mouseup 事件,遍历nodeList,通过el与event.target来判断是否在外部点击,从而执行对应的处理函数

  • badge
    角标的布局使用了先 absolute 再 transform 的技巧,另外使用了 sup 这个语义化标签,而不是 span
  • breadcrumb
    需要与 breadcrumb-item 一起使用,使用了 provide / inject 机制将 breadcrumb 实例传给 breadcrumb-item
  • button
    使用了 inject 来兼容当作为 form 子元素使用时的情形
  • calendar
    由 button-group 作为 header , date-table 作为 content 组合而成,最麻烦的部分是计算每一行的日期
  • card
    比较简单,由具名slot 提供 header,默认slot部分作为 body
  • carousel
    需要与 carousel-item 一起使用,通过 this.children,child.options.name === 'ElCarouselItem' 获取传入的 carousel-item 实例,计算 每个 item 的位移比较麻烦
  Vue.prototype.$loading = Loading.service;
  Vue.prototype.$msgbox = MessageBox;
  Vue.prototype.$alert = MessageBox.alert;
  Vue.prototype.$confirm = MessageBox.confirm;
  Vue.prototype.$prompt = MessageBox.prompt;
  Vue.prototype.$notify = Notification;
  Vue.prototype.$message = Message;
  • Loading
    loading 既可以以指令的形式使用,也可以用服务的方式,如果全局引入Element,则还可以用 this.$loading使用
  • MessageBox
    alert,confirm,prompt均由MessageBox 实现,实现:一个模板+消息队列,当同时调用多个alert时,只会创建一个模板,多个alert的文案等信息会存在消息队列中,本质上也是单例模式
  • Message
    分全局引入和局部引入两种方式调用
// 全局
this.$message({type:'success',message: '恭喜你,这是一条成功消息'})
// 局部
Message.success('恭喜你,这是一条成功消息')

当多次调用时,仍会创建多个实例

  • Notification
    和 Message 的实现基本一致,有个不同的地方在于组件销毁的处理:Message 是监听 after-leave 后销毁,Notification 是监听 transitionend 后销毁,这样做的原因在于Notification 可以手动关闭,而 Message 不能

2.4、样式分析

ElamentUI 以 BEM 的方式组织样式,以 Alert.vue 分析:

<template>
  <transition name="el-alert-fade">
    <div
      class="el-alert"
      :class="[typeClass, center ? 'is-center' : '', 'is-' + effect]"
      v-show="visible"
      role="alert"
    >
      <i class="el-alert__icon" :class="[ iconClass, isBigIcon ]" v-if="showIcon"></i>
      <div class="el-alert__content">
        <span class="el-alert__title" :class="[ isBoldTitle ]" v-if="title || $slots.title">
          <slot name="title">{{ title }}</slot>
        </span>
        <p class="el-alert__description" v-if="$slots.default && !description"><slot></slot></p>
        <p class="el-alert__description" v-if="description && !$slots.default">{{ description }}</p>
        <i class="el-alert__closebtn" :class="{ 'is-customed': closeText !== '', 'el-icon-close': closeText === '' }" v-show="closable" @click="close()">{{closeText}}</i>
      </div>
    </div>
  </transition>
</template>

再看对应的 alert.scss:

// 省略了部分
@import "mixins/mixins";
@import "common/var";

@include b(alert) {
  width: 100%;
  padding: $--alert-padding;
  margin: 0;
  box-sizing: border-box;
  border-radius: $--alert-border-radius;
  position: relative;
  background-color: $--color-white;
  overflow: hidden;
  opacity: 1;
  display: flex;
  align-items: center;
  transition: opacity .2s;

  @include when(center) {
    justify-content: center;
  }

  @include m(success) {
    &.is-light {
      background-color: $--alert-success-color;
      color: $--color-success;

      .el-alert__description {
        color: $--color-success;
      }
    }

    &.is-dark {
      background-color: $--color-success;
      color: $--color-white;
    }
  }

  @include e(closebtn) {
    font-size: $--alert-close-font-size;
    opacity: 1;
    position: absolute;
    top: 12px;
    right: 15px;
    cursor: pointer;

    @include when(customed) {
      font-style: normal;
      font-size: $--alert-close-customed-font-size;
      top: 9px;
    }
  }
}

其中的 b,e,m,when都是定义好的 mixin;这种实现让代码显得异常整洁。且大部分组件都是这种模式,维护起来也是非常方便,值得借鉴!

3、小结 & 收获

小结

回答开始的问题

  • 组件的两种使用方式是如何做的(Tag模式|API 模式)?
    通过 .vue 形式提供 tag 模式调用,通过将构造函数挂在Vue原型上实现 API 模式调用,这种方式本质上也利用了 .vue 文件,只不过通过 Vue.extend() 方法做了一次内容提取,然后搞些单例模式处理实例等等。
  • scss 文件是如何优雅组织的 ?
    var.scss 命名所有变量;mixin.scss 定义通用 @mixin;icon.scss 存放所有icon;common.scss 定义通用 scss;其他一个组件对应一个scss。优雅的地方在于 mixin 的巧妙设计,如 @mixin b/e/m/when 等

收获

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

推荐阅读更多精彩内容