在 Element-UI 的 Table 組件上添加列拖拽效果

Element-UI 的 Table 組件很強大，可是咱們的需求更強大...

簡單粗暴的來一發效果圖：

 

1、數據驅動

傳統的拖動效果，都是基於經過 mousedown、mousemove、mouseup 事件來修改刪減 dom 節點

但 Vue 是一個數據驅動的前端框架，開發時應儘可能避免操做 dom

並且 Element-UI 的 Table 組件封裝得很嚴謹，直接操做 dom 很容易產生不可預計的 bug

因此個人核心思路就是：經過一個數組渲染表頭（列），而後修改這個數組的順序，從而修改列表的列排序

 

template 部分：

  <div class="w-table" :class="{'w-table_moving': dragState.dragging}">
    <el-table :data="data"
      :border="option.border"
      :height="option.height"
      :max-height="option.maxHeight"
      :style="{ width: parseInt(option.width)+'px' }"
      :cell-class-name="cellClassName" 
      :header-cell-class-name="headerCellClassName"
    >
      <slot name="fixed"></slot>
      <el-table-column v-for="(col, index) in tableHeader" :key="index"
        :prop="col.prop"
        :label="col.label"
        :width="col.width"
        :min-width="col.minWidth"
        :type="col.type"
        :header-align="col.headerAlign"
        :column-key="index.toString()"
        :render-header="renderHeader"
      >
      </el-table-column>
    </el-table>
  </div>

上面的 data 是列表數據集合，option 是 Table 組件配置項，header 是表頭數據集合，由父組件傳入

  props: {
    data: {
      default: function () {
        return []
      },
      type: Array
    },
    header: {
      default: function () {
        return []
      },
      type: Array
    },
    option: {
      default: function () {
        return {}
      },
      type: Object
    }
  }

配置項能夠根據 Element-UI 的 api 自行刪減

但有幾個參數在組件內部被徵用：

1. header-cell-class-name

綁定了一個函數，動態給表頭單元格添加 class，從而實現拖動中的虛線效果。

2. cell-class-name

同上。用一個函數給表頭之外的全部單元格添加 class，用於區分選中列。

3. column-key

綁定爲 header 數組的 index，用於肯定須要修改的 header 元素下標

4. render-header

表頭渲染函數，用以添加自定義方法，以監聽 mousemove 等相關事件

 

2、記錄拖動狀態

拖動過程當中須要記錄幾個關鍵參數：

  data () {
    return {
      tableHeader: this.header,
      dragState: {
        start: -9, // 起始元素的 index
        end: -9, // 移動鼠標時所覆蓋的元素 index
        dragging: false, // 是否正在拖動
        direction: undefined // 拖動方向
      }
    }
  }

另外父元素傳入了一個表頭數據 header，但拖動完成後會修改這個數據

在子組件中直接修改父元素的數據是不推薦的，因此這裏初始化了一個 tableHeader 用於託管表頭數據 header

但爲了讓 header 修改時，tableHeader 也能響應修改，就得添加一個監視器 watch

  watch: {
    header (val, oldVal) {
      this.tableHeader = val
    }
  }

 

3、自定義表頭

Element-UI 的 Table 組件爲了實現【拖拽邊框以修改列寬】的功能，沒有將 mousemove、mouseup、mousedown 這三個事件暴露出來

因此須要自定義表頭，並手動添加鼠標事件的處理函數，這就須要用到 renderHeader() 方法

    renderHeader (createElement, {column}) {
      return createElement(
        'div', {
          'class': ['thead-cell'],
          on: {
            mousedown: ($event) => { this.handleMouseDown($event, column) },
            mousemove: ($event) => { this.handleMouseMove($event, column) }
          }
        }, [
          // 添加 <a> 用於顯示錶頭 label
          createElement('a', column.label),
          // 添加一個空標籤用於顯示拖動動畫
          createElement('span', {
            'class': ['virtual']
          })
        ])
    },

三個鼠標事件中，第一個參數是事件對象，第二個是表頭對象

在對應的處理函數中，能夠經過 column.columnKey 獲取到對應的表頭元素下標 index

空標籤 <span class="virtual"> 用來顯示拖動時的動畫（虛線）

 

4、事件處理

按下鼠標時，記錄下起始列。鼠標擡起時，記錄下結束列。根據兩者之差計算出拖動的方向。

而後根據起始列和結束列的位置，將表頭數據從新排序，從而實現列的拖動

拖動過程的處理函數以下：

// 按下鼠標開始拖動
handleMouseDown (e, column) {
  this.dragState.dragging = true
  this.dragState.start = parseInt(column.columnKey)
  // 給拖動時的虛擬容器添加寬高
  let table = document.getElementsByClassName('w-table')[0]
  let virtual = document.getElementsByClassName('virtual')
  for (let item of virtual) {
    item.style.height = table.clientHeight - 1 + 'px'
    item.style.width = item.parentElement.parentElement.clientWidth + 'px'
  }
　document.addEventListener('mouseup', this.handleMouseUp);
},

// 鼠標放開結束拖動
handleMouseUp () {
  this.dragColumn(this.dragState)
  // 初始化拖動狀態
  this.dragState = {
    start: -9,
    end: -9,
    dragging: false,
    direction: undefined
  }
　document.removeEventListener('mouseup', this.handleMouseUp);
},

// 拖動中
handleMouseMove (e, column) {
  if (this.dragState.dragging) {
    let index = parseInt(column.columnKey) // 記錄起始列
    if (index - this.dragState.start !== 0) {
      this.dragState.direction = index - this.dragState.start < 0 ? 'left' : 'right' // 判斷拖動方向
      this.dragState.end = parseInt(column.columnKey)
    } else {
      this.dragState.direction = undefined
    }
  } else {
    return false
  }
},

// 拖動易位
dragColumn ({start, end, direction}) {
  let tempData = []
  let left = direction === 'left'
  let min = left ? end : start - 1
  let max = left ? start + 1 : end
  for (let i = 0; i < this.tableHeader.length; i++) {
    if (i === end) {
      tempData.push(this.tableHeader[start])
    } else if (i > min && i < max) {
      tempData.push(this.tableHeader[ left ? i - 1 : i + 1 ])
    } else {
      tempData.push(this.tableHeader[i])
    }
  }
  this.tableHeader = tempData
},

 

5、動態樣式

在拖動過程當中，經過 mousemove 事件，改變當前列的表頭狀態

而後藉助 headerCellClassName, cellClassName 動態修改單元格 class

  headerCellClassName ({column, columnIndex}) {
    let active = columnIndex - 1 === this.dragState.end ? `darg_active_${this.dragState.direction}` : ''
    let start = columnIndex - 1 === this.dragState.start ? `darg_start` : ''
    return `${active} ${start}`
  }

  cellClassName ({column, columnIndex}) {
    return (columnIndex - 1 === this.dragState.start ? `darg_start` : '')
  }

這裏的 darg_active 用來給上面的空標籤 <span class="virtual"> 添加虛線，darg_start 用於實現選中效果

貼一下我本身寫的完整樣式（使用了 sass 做爲編譯工具）：

<style lang="scss">
.w-table {
　.el-table .darg_start {
   background-color: #f3f3f3; 
  }
  .el-table th {
    padding: 0;
    .virtual{
      position: fixed;
      display: block;
      width: 0;
      height: 0;
      margin-left: -10px;
      background: none;
      border: none;
    }
    &.darg_active_left {
      .virtual {
        border-left: 2px dotted #666;
        z-index: 99;
      }
    }
    &.darg_active_right {
      .virtual {
        border-right: 2px dotted #666;
        z-index: 99;
      }
    }
  }
  .thead-cell {
    padding: 0;
    display: inline-flex;
    flex-direction: column;
    align-items: left;
    cursor: pointer;
    overflow: initial;
    &:before {
      content: "";
      position: absolute;
      top: 0;
      left: 0;
      bottom: 0;
      right: 0;
    }
  }
  &.w-table_moving {
    .el-table th .thead-cell{
      cursor: move !important;
    }
    .el-table__fixed {
      cursor: not-allowed;
    }
  }
}

 

六：父組件調用

<template>
<div>
  <wTable :data="tableData" :header="tableHeader" :option="tableOption">
    <el-table-column slot="fixed"
      fixed
      prop="date"
      label="日期"
      width="150">
    </el-table-column>
  </wTable>
</div>
</template>

<script>
import wTable from '@/components/w-table.vue'
export default {
  name: 'Table',
  data () {
    return {
      tableOption: {
        border: true,
        maxHeight: 500
      },
      tableHeader: [{
        prop: 'name',
        label: '姓名',
        sortable: true,
        sortMethod: this.handleNameSort
      }, {
        prop: 'province',
        label: '省份',
        minWidth: '120'
      }, {
        prop: 'city',
        label: '市區',
        minWidth: '120'
      }, {
        prop: 'address',
        label: '地區',
        minWidth: '150'
      }, {
        prop: 'zip',
        label: '郵編',
        minWidth: '120'
      }],

      tableData: [{
        date: '2016-05-03',
        name: '王小虎',
        province: '上海',
        city: '普陀區',
        address: '上海市普陀區金沙江路 1518 弄',
        zip: 200333
      }, {
        date: '2016-05-02',
        name: '王小虎',
        province: '上海',
        city: '普陀區',
        address: '上海市普陀區金沙江路 1518 弄',
        zip: 200333
      }, {
        date: '2016-05-04',
        name: '王小虎',
        province: '上海',
        city: '普陀區',
        address: '上海市普陀區金沙江路 1518 弄',
        zip: 200333
      }, {
        date: '2016-05-01',
        name: '王小虎',
        province: '上海',
        city: '普陀區',
        address: '上海市普陀區金沙江路 1518 弄',
        zip: 200333
      }, {
        date: '2016-05-08',
        name: '王小虎',
        province: '上海',
        city: '普陀區',
        address: '上海市普陀區金沙江路 1518 弄',
        zip: 200333
      }, {
        date: '2016-05-06',
        name: '王小虎',
        province: '上海',
        city: '普陀區',
        address: '上海市普陀區金沙江路 1518 弄',
        zip: 200333
      }]
    }
  },
  methods: {
    handleNameSort () {
      console.log('handleNameSort')
    }
  },
  components: {
    wTable
  }
}
</script>