ElementUI 簡要原始碼解析——Basic篇

格子熊發表於2019-07-16

Layout 佈局

row

佈局元件中的父元件,用於控制子元件。很簡單的一個佈局標籤,主要通過 justify 和 align 控制子元素的對齊方式,使用 render 函式通過傳入的 tag 屬性控制生成的標籤。

在這裡推薦學習下 render 函式和 JSX 的寫法,因為之後比較複雜的元件都是通過 render函式 + JSX 的方式來寫的。

// 核心程式碼
render(h) {
    return h(this.tag, {
        class: [
            'el-row',
            this.justify !== 'start' ? `is-justify-${this.justify}` : '',
            this.align !== 'top' ? `is-align-${this.align}` : '',
            { 'el-row--flex': this.type === 'flex' }
        ],
        style: this.style
    }, this.$slots.default);
}

col

佈局元件中的子元件,通過傳入的props控制佔據的列數、偏移、大小等,通過 forEach 對每個屬性進行處理,生成包含對應樣式的 classList。

最後將 classList 傳入 createElement 函式(h)中的第二個引數(標籤選項)中,如此,就生成了所需要的佈局。

// 核心程式碼
render (h) {
    // 省略,通過props計算classList
    return h(this.tag, {
      class: ['el-col', classList],
      style
    }, this.$slots.default);
}

Container 佈局容器

container

父容器元件,根據傳入的direction欄位,決定樣式是水平還是垂直。當沒有傳入direction欄位時,根據插槽中子元件是否含有 header 或 footer元件,如果含有則為垂直,否則為水平。

// 核心程式碼
computed: {
    isVertical() {
        if (this.direction === 'vertical') {
            return true;
        } else if (this.direction === 'horizontal') {
            return false;
        }
        return this.$slots && this.$slots.default
            ? this.$slots.default.some(vnode => {
            const tag = vnode.componentOptions && vnode.componentOptions.tag;
            return tag === 'el-header' || tag === 'el-footer';
        })
        : false;
    }
}

最簡單的元件之一,通過傳入的 height 引數定義 style 高度。

aside

最簡單的元件之一,通過傳入的 width 引數控制 style 寬度。

main

真正意義上的最簡單容器元件,包含插槽的純容器。

最簡單的元件之一,通過傳入的 height 引數定義 style 高度。

佈局容器總結

何為容器?在我的理解中,容器就是一個限制大小的盒子。佈局容器通過屬性定義 header、aside、footer 的高寬的行內樣式,接下來只需要定義 main 為 flex: 1 即可實現自適應佈局。

Icon 圖示

感覺比較沒有意義的一個元件,通過傳入的 name 來組成類似於 el-icon-name 格式的類,然後將這個類定義在 i 標籤內。不過大多數人都不會用這個元件,為什麼?因為連官網推薦寫法都是直接在 i 標籤內新增對應圖示的類。

Button 按鈕

Button 元件是 Basic 裡面唯一一個稍微複雜一點的元件。它與其他 Basic 元件的最大區別在於,通過 provide/inject 獲取了祖先元件,然後參照祖先元件的尺寸引數,將 Button 元件的尺寸引數設為一致。

Button 元件的尺寸由三個因素決定:

  1. 直接設定元件的 size 屬性,該因素具有最高優先順序,類比於樣式中的行內樣式。
  2. 當 Button 運用在 Form 元件中,可以通過配置 Form 元件的 size 屬性來決定,當沒有直接設定 Button 元件的 size 屬性時,由該因素決定 Button 元件的尺寸,類比於樣式中的樣式繼承。
  3. 當前兩種因素都不存在時,由 this.$ELEMENT 物件中的 size 屬性決定。What? this.$ELEMENT 什麼鬼?它是接收初始化 ElementUI 時傳入的尺寸引數的物件,包含兩個屬性:size 以及 zIndex,方便全域性定義各種元件的尺寸。類比於樣式中的 body 樣式繼承。
// 核心程式碼
export default {
    name: 'ElButton',
    // 通過 inject 獲取 elForm 以及 elFormItem 這兩個元件
    inject: {
        elForm: {
            default: ''
        },
        elFormItem: {
            default: ''
        }
    },
    // ...
    computed: {
        _elFormItemSize() {
            return (this.elFormItem || {}).elFormItemSize;
        },
        buttonSize() {
            // 三種因素決定按鈕的尺寸
            return this.size || this._elFormItemSize || (this.$ELEMENT || {}).size;
        },
        //...
    },
    // ...
};

和一般文字連結區別不大的一個元件,主要區別在於兩點:

  1. 可以通過 disabled 屬性設定禁用,原理是當 disabled 屬性為 false 時,將 a 標籤的 href 屬性置為 null,同時阻止阻止其向上丟擲 click 事件。
  2. 靈活運用插槽,看似該元件只有一個插槽,實則擁有兩個插槽,一個是匿名插槽,一個是名為 icon 的具名插槽,通過合理的設定可以快速實現各種需求。

值得一提的是,該元件還使用了一個通用元件開發的小技巧:通過 v-bind="$attrs" 進行快速屬性賦值。為什麼要這樣做?因為 a 標籤可以含有各種 html 屬性,而這些屬性我們不可能一一通過 props 接收然後賦值到 a 標籤的屬性上。

因此,我們可以通過 v-bind="$attrs" 無視傳入的屬性是什麼,一股腦將其賦值到 a 標籤上。這相當於,開發者可以直接像操作 a 標籤一樣操作 Link 元件,大大方便了元件的使用。

<template>
  <a
    :class="[
      'el-link',
      type ? `el-link--${type}` : '',
      disabled && 'is-disabled',
      underline && !disabled && 'is-underline'
    ]"
    :href="disabled ? null : href"
    v-bind="$attrs"
    @click="handleClick"
  >

    <i :class="icon" v-if="icon"></i>

    <span v-if="$slots.default" class="el-link--inner">
      <slot></slot>
    </span>

    <template v-if="$slots.icon"><slot v-if="$slots.icon" name="icon"></slot></template>
  </a>
</template>

總結

通讀了 Basic 系列的原始碼,可以發現,這一部分的原始碼其實相對比較簡單,但是,卻又很多的小細節點值得學習,比如:通過 v-bind=$attrs 定義標籤屬性、通過組合插槽方便元件使用、通過多種因素設定屬性以及各種預設設計等等。

相關文章