vxe-table

A very powerful Vue table component.

Features

• 基础
• 尺寸
• 斑马线条纹
• 带边框
• 单元格样式
• 列宽拖动
• 流体高度
• 固定表头
• 固定列
• 固定表头和列
• 表头分组
• 序号
• 单选
• 多选
• 排序
• 筛选
• 合并行或列
• 表尾合计
• 导出 CVS
• 显示/隐藏列
• 加载中
• 格式化内容
• 自定义模板
• 快捷菜单
• 滚动渲染
• 展开行
• 可编辑表格
• 数据校验
• 全键盘操作
• Excel 表格

Docs

查看文档

Installing

npm install xe-utils vxe-table

Get on unpkg and cdnjs

<!-- 引入样式 -->
<link rel="stylesheet" href="https://unpkg.com/vxe-table/lib/index.css">
<!-- 引入脚本 -->
<script src="https://unpkg.com/xe-utils"></script>
<script src="https://unpkg.com/vxe-table"></script>

import Vue from 'vue'
import VXETable from 'vxe-table'
import 'vxe-table/lib/index.css'

Vue.use(VXETable)

Global config

import Vue from 'vue'
import VXETable from 'vxe-table'
import 'vxe-table/lib/index.css'

Vue.use(VXETable, {
  // 默认尺寸
  size: 'small',
  // 全局快捷菜单
  contextMenu: null,
  // 自定义渲染器
  renderMap: {},
  // 自定义图标配置
  iconMap: {
    sortAsc: 'vxe-sort--asc-icon',
    sortDesc: 'vxe-sort--desc-icon',
    filter: 'vxe-filter--icon',
    edit: 'vxe-edit--icon'
  },
  // 优化配置项
  optimized: {
    showOverflow: 'tooltip',
    scrollX: {
      gt: 60,
      oSize: 5,
      rSize: 16
    },
    scrollY: {
      gt: 500,
      oSize: 20,
      rSize: 80
    }
  }
})

Theme

// Case 1. 引入默认的样式
import 'vxe-table/lib/index.css'

// Case 2. 自定义表格颜色（复制 style/variable.scss 到自己的项目中，修改颜色变量，然后引入）
// @import 'assets/style/vxe-table/variable.scss';
// @import 'vxe-table/style/table.scss';

// Case 3. 重写主题样式（复制 style/table.scss 到项目中自行修改）
// @import 'assets/style/vxe-table/variable.scss';
// @import 'assets/style/vxe-table/table.scss';

I18n

import Vue from 'vue'
import VueI18n from 'vxe-i18n'
import VXETable from 'vxe-table'
import zhCNLocat from 'vxe-table/lib/locale/lang/zh_CN'
import enLocat from 'vxe-table/lib/locale/lang/zh_CN'

const messages = {
  zh_CN: {
    ...zhCNLocat
  },
  en: {
    ...enLocat
  }
}

const i18n = new VueI18n({
  locale: 'zh_CN',
  messages,
})

Vue.use(VXETable, {
  i18n: (key, value) => i18n.t(key, value)
})

new Vue({ i18n }).$mount('#app')

API

Components

• vxe-table
• vxe-table-column
• vxe-grid
• vxe-excel

Table

<vxe-table :data.sync="tableData">
  <vxe-table-column type="selection" width="60"></vxe-table-column>
  <vxe-table-column prop="name" label="Name"></vxe-table-column>
  <vxe-table-column prop="address" label="Address"></vxe-table-column>
</vxe-table>

Table Attributes

参数	说明	类型	可选值	默认值
data	显示的数据	Array	—	—
customs	初始化绑定动态列	Array	—	—
height	表格的高度	Number	—	—
maxHeight	表格的最大高度	Number	—	—
resizable	是否允许拖动列宽调整大小	Boolean	—	false
stripe	是否带有斑马纹	Boolean	—	false
border	是否带有纵向边框	Boolean	—	false
size	表格的尺寸	String	medium / small / mini	—
fit	列的宽度是否自撑开	Boolean	—	true
loading	表格是否加载中	Boolean	—	false
show-header	是否显示表头	Boolean	—	true
highlight-current-row	是否要高亮当前选中行	Boolean	—	false
highlight-hover-row	鼠标移到行是否要高亮显示	Boolean	—	false
row-class-name	给行附加 className，也可以是函数 Function({row, rowIndex, data})	String/Function	—	—
cell-class-name	给单元格附加 className，也可以是函数 Function({row, rowIndex, column, columnIndex, data})	String/Function	—	—
header-row-class-name	给表头的行附加 className，也可以是函数 Function({rowIndex})	String/Function	—	—
header-cell-class-name	给表头的单元格附加 className，也可以是函数 Function({rowIndex, column, columnIndex})	String/Function	—	—
footer-row-class-name	给表尾的行附加 className，也可以是函数 Function({rowIndex})	String/Function	—	—
footer-cell-class-name	给表尾的单元格附加 className，也可以是函数 Function({rowIndex, column, columnIndex})	String/Function	—	—
show-footer	是否显示表尾合计	Boolean	—	—
footer-method	表尾合计的计算方法 Function({columns, data})	Function	—	—
span-method	合并行或列，该函数 Function({row, rowIndex, column, columnIndex, data}) 返回计算后的值	Object	—	{ rowspan: 1, colspan: 1}
row-key	行数据的 Key	String	—	—
context-menu	快捷菜单配置项	Object	—	{header, body, footer}
mouse-config	鼠标配置项	Object	—	options
Keyboard-config	按键配置项	Object	—	options
edit-config	可编辑配置项	Object	—	options
edit-rules	校验规则配置项	Object	—	options
optimized	优化配置项	Object/Boolean	—	options
selectEditMethod	只对 Keyboard-config={isEdit: true} 有效，用于重写选中编辑处理逻辑，该函数 Function({row, rowIndex, column, columnIndex, cell}, event) 可以返回 false 来阻止默认行为	Function	—	—

context-menu 快捷菜单配置项说明（配合 context-menu-link 事件使用）

属性	描述	类型	可选值	默认值
disabled	是否禁用表格头部右键	Boolean	—	—
options	表格头部菜单配置	Array	—	{ code, name, prefixIcon, suffixIcon, disabled }
visibleMethod	该函数 Function({row, rowIndex, column, columnIndex}, event) 的返回值用来决定是否允许显示右键菜单	Function	—	—

context-menu 快捷键说明

属性	描述
Arrow Up ↑	移动到上一个菜单选项
Arrow Down ↓	移动到下一个菜单选项
Arrow Down →	打开右侧的二级菜单
Enter	选中当前菜单选项
Spacebar	选中当前菜单选项

optimized 优化配置项说明

属性	描述	类型	可选值	默认值
animat	表格动画效果开关（关闭后视觉效果更快）	Boolean	—	true
showOverflow	设置所有行不允许换行（设置后对于固定列能大幅提升性能）	String	ellipsis / title / tooltip	—
scrollX	横向 X 滚动渲染配置	Object	—	{gt: 60, oSize: 5, rSize: 16}
scrollY	纵向 Y 滚动渲染配置	Object	—	{gt: 500, oSize: 30, rSize: 100}

scrollXY 滚动渲染配置项说明

属性	描述	类型
gt	指定大于多少范围时自动启动滚动渲染	Number
oSize	超过指定阈值重新渲染	Number
rSize	每次渲染条数	Number
vSize	指定可视区域条数，默认自动计算	Number
rHeight	指定行高，默认自动计算	Number

mouse-config 鼠标相关配置项说明

属性	描述	类型	可选值	默认值
selected	开启左键选中功能	Boolean	—	false
checked	开启鼠标移动单元格批量选中功能	Boolean	—	false

keyboard-config 键盘相关配置项说明

属性	描述	类型	可选值	默认值
isArrow	开启方向键功能	Boolean	—	false
isTab	开启 Tab 键功能	Boolean	—	false
isCut	开启复制粘贴功能	Boolean	—	false
isEdit	开启任意键进入编辑（功能键除外）	Boolean	—	false

keyboard-config 快捷键说明

属性	描述
Arrow Up ↑	移动到当前活动单元格上面的单元格
Arrow Down ↓	移动到当前活动单元格下面的单元格
Arrow Left ←	移动到当前活动单元格左边的单元格
Arrow Right →	移动到当前活动单元格右边的单元格
Tab	移动到当前选中或活动单元格的右侧单元格，如果到最后一列且存在下一行，则从下一行开始移动
Enter	取消编辑并移动到当前活动单元格下面的单元格
Delete	清空内容
Backspace	清空内容并激活选中单元格为编辑状态
F2	激活单元格编辑
Esc	取消单元格编辑
Ctrl + C	复制选中的单元格内容
Ctrl + X	剪贴选中的单元格内容
Ctrl + V	粘贴选中的单元格内容
Ctrl + A	选中所有单元格

edit-config 可编辑配置项说明

属性	描述	类型	可选值	默认值
trigger	触发方式	String	manual（手动触发方式，只能用于 mode=row） / click（点击触发编辑） / dblclick（双击触发编辑）	click
mode	编辑模式	String	cell（单元格编辑模式） / row（行编辑模式）	cell
showIcon	是否显示列头编辑图标	Boolean	—	true
showStatus	是否显示单元格值的修改状态	Boolean	—	false
autoClear	当点击非编辑列之后，是否自动清除单元格的激活状态	Boolean	—	true

edit-rules 校验规则配置项说明

属性	描述	类型	可选值	默认值
required	是否必填	Boolean	—	—
min	校验值最小长度（如果 type=number 则比较值大小）	Number	—	—
max	校验值最大长度（如果 type=number 则比较值大小）	Number	—	—
type	类型校验	String	number / string	string
pattern	正则校验	RegExp	—	—
validator	自定义校验方法	Function(rule, value, callback)	—	—
trigger	触发校验方式	String	blur / change	change

Table Events

事件名	说明	参数
select-all	只对 type=selection 有效，当手动勾选全选时触发的事件	{selection,checked},event
select-change	只对 type=selection/radio 有效，当手动勾选时触发的事件	{selection,checked,row,column},event
cell-click	单元格被点击时会触发该事件	{row,rowIndex,column,columnIndex,cell},event
cell-dblclick	单元格被双击时会触发该事件	{row,rowIndex,column,columnIndex,cell},event
header-cell-click	表头的单元格被点击时会触发该事件	{column,columnIndex,cell},event
context-menu-link	当点击上下文菜单后触发	menu,event
clear-actived	单元格编辑状态下被清除时会触发该事件	{row,rowIndex,column,columnIndex,cell},event
edit-actived	单元格被激活编辑时会触发该事件	{row,rowIndex,column,columnIndex,cell},event
edit-disabled	当点击后单元格如果是禁用状态时会触发该事件	{row,rowIndex,column,columnIndex,cell},event
valid-error	当数据校验不通过时会触发该事件	{row,rowIndex,column,columnIndex,cell}

Table Methods

方法名	描述	参数
reload	初始化数据	data
insert	从第一行新增一行新数据	record
insertAt	第二个参数 row 从指定位置新增一条数据； null 从第一行新增一行新数据；-1 从最后新增一条数据	record,row
revert	还原更改，还原指定行 row 或者整个表格的数据	rows?,prop?
remove	删除指定行数据，指定 row 或 [row, ...] 删除多条数据	rows
getRecords	获取表格所有数据，也可以指定索引获取数据	rowIndex
getColumns	获取表格所有列，也可以指定索引获取列	columnIndex
getAllRecords	获取表格数据集合	—
getInsertRecords	获取新增数据	—
getRemoveRecords	获取已删除数据	—
getUpdateRecords	获取已修改数据	—
setActiveRow	只对 mode=cell 有效，激活行编辑	row
setActiveCell	只对 mode=row 有效，激活单元格编辑	row,prop
setSelectCell	只对 trigger!=manual 有效，选中单元格	row,prop
setExpandRow	设置展开行，二个参数设置这一行展开与否	rows,checked
setCurrentRow	用于单选表格，设置某一行为选中状态，第二个参数为选中与否	row?,checked
setSelection	用于多选表格，设置行为选中状态，第二个参数为选中与否	rows,checked
toggleRowSelection	用于多选表格，切换某一行的选中状态	row
toggleAllSelection	用于多选表格，切换所有行的选中状态	—
toggleRowExpansion	用于可展开表格，切换展开行	row
clearCurrentRow	用于单选表格，清空用户的选择	—
clearSelection	用于多选表格，清空用户的选择	—
clearExpand	清空展开行，数据会恢复成未展开的状态	—
clearSort	清空排序条件，数据会恢复成未排序的状态	—
clearFilter	清空筛选条件，数据会恢复成未筛选的状态	—
clearChecked	清除单元格批量选中状态	—
clearSelected	清除单元格选中状态	—
clearActivedd	清除单元格激活状态	—
clearCopyed	清空已复制的内容	—
computeWidth	重新计算并更新列宽	—
isScrollXLoad	判断是否启用了横向 X 滚动渲染	—
isScrollYLoad	判断是否启用了纵向 Y 滚动渲染	—
validateRow	对表格某一行进行校验的方法，参数为行数据和一个回调函数。该回调函数会在校验结束后被调用，并传入两个参数：（是否校验成功，最近一列未通过校验的字段）。若不传入回调函数，则会返回一个 promise	row,callback
validate	对整个表格进行校验的方法，参数为一个回调函数。该回调函数会在校验结束后被调用，并传入两个参数：（是否校验成功，最近一列未通过校验的字段）。若不传入回调函数，则会返回一个 promise	callback
exportCsv	将表格数据导出为 .csv 文件，说明：支持IE9+、Edge、Chrome、Firefox 等常用浏览器。IE11以下可能存在中文乱码问题，部分浏览器需要手动修改后缀名为 .csv	options

exportCsv 参数说明

属性	描述	类型	可选值	默认值
filename	文件名	String	—	table.csv
original	是否导出源数据	Boolean	—	false
isHeader	是否显示表头	Boolean	—	false
download	是否马上下载，如果设置为 false 则通过返回结果为内容的 Promise	Boolean	—	true
data	自定义数据	Array	—	—
columns	自定义列	Array	—	—
columnFilterMethod	列过滤方法，该函数 Function(column,columnIndex) 的返回值用来决定该列是否导出	Function	—	—
dataFilterMethod	数据过滤方法，该函数 Function(row,rowIndex) 的返回值用来决定该数据是否导出	Function	—	—

Table-column

<vxe-table-column prop="name" label="Name"></vxe-table-column>

Table-column Attributes 参数

参数	说明	类型	可选值	默认值
type	列的类型	String	index / selection / radio / expand	—
edit-render	列编辑配置项	Object/Boolean	—	options
prop	列属性	String	—	—
label	列标题	String	—	—
width	列宽度	String	—	—
min-width	最小列宽度，把剩余宽度按比例分配	String	—	—
fixed	将列固定在左侧或者右侧	String	—	left
align	列对其方式	String	—	left
header-align	表头对齐方式	String	—	—
ellipsis	当内容过长时显示为省略号	Boolean	—	false
show-overflow-title	当内容过长显示为省略号和原生的 title 显示内容	Boolean	—	false
show-overflow-tooltip	当内容过长显示为省略号并用 tooltip 显示完整内容	Boolean	—	false
formatter	格式化显示内容 Function({cellValue, row, rowIndex, column, columnIndex})	Function	—	—
index-method	只对 type=index 有效，自定义索引方法 Function({row, rowIndex, column, columnIndex})	Function	—	—
sortable	是否允许列排序，如果是服务端排序需要设置为custom	Boolean	—	—
sortBy	只对 sortable 有效，自定义排序的属性	String/Array	—	—
filters	配置筛选条件数组	Array	—	—
filter-multiple	只对 filters 有效，筛选是否允许多选	Boolean	—	true
filter-method	只对 filters 有效，自定义筛选方法 Function({value, row, column})	Function	—	—
column-key	列的 key	String/Number	—	—

edit-render 配置项说明

属性	描述	类型	可选值	默认值
type	渲染类型	String	default（组件触发后可视） / visible（组件一直可视）	default
name	支持渲染的组件	String	input / textarea	input
autofocus	如果是自定义渲染可以指定聚焦的 class	String	—	—

Table-column Scoped Slot

name	说明
—	自定义显示内容，参数为 { row, rowIndex, column, columnIndex, fixed, isHidden }
header	自定义表头的内容，参数为 { column, columnIndex, fixed, isHidden }
edit	自定义可编辑组件模板，参数为 { column, columnIndex, fixed, isHidden }

Plugins

• vxe-table-plugin-element 用于集成 element-ui 简化渲染配置
• vxe-table-plugin-iview 用于集成 iview 简化渲染配置

Example

<template>
  <div>
    <button @click="$refs.vTable.exportCsv()">Export.cvs</button>
    <vxe-table ref="vTable" :data.sync="tableData">
      <vxe-table-column type="index" width="60"></vxe-table-column>
      <vxe-table-column prop="name" label="Name"></vxe-table-column>
      <vxe-table-column prop="sex" label="Sex"></vxe-table-column>
      <vxe-table-column prop="address" label="Address"></vxe-table-column>
    </vxe-table>
  </div>
</template>

<script>
export default {
  data () {
    return {
      tableData: [
        {
          id: 10001,
          checked: false,
          name: 'test1',
          role: 'developer',
          sex: 'Man',
          date: '2019-05-01',
          time: 1556677810888,
          region: 'ShenZhen',
          address: 'address abc123'
        }
      ]
    }
  }
}
</script>

License

Copyright (c) 2019-present, Xu Liangzhan