vxe-table

A more powerful, extensible, configurable Vue Table component.

• vxe-table 的设计理念
  • 精简的 API（简洁、高效、通用）
  • 更加灵活的自定义配置项，更高的可扩展性（兼容任意组件库，不污染全局样式及变量）
  • 强大的功能的同时兼具性能

😉 如果有更好的建议、优化点或 Bug 都欢迎提 Issues

Browser Support

11+ ✔	Latest ✔	Latest ✔	Latest ✔	Latest ✔	8+ ✔

Features

• Basics table （基础）
• Size （尺寸）
• Striped （斑马线条纹）
• Table with border （带边框）
• Cell style （单元格样式）
• Column resizable （列宽拖动）
• Fluid-height table with fixed header （流体高度）
• Resize height and width （响应式宽高）
• Table with fixed header （固定表头）
• Table with fixed column （固定列）
• Table with fixed columns and header （固定表头和列）
• Grouping table head （表头分组）
• Table sequence （序号)
• Radio （单选)
• Checkbox （多选）
• Sorting （排序）
• Filter （筛选）
• Rowspan and colspan （合并行或列）
• Footer summary （表尾合计）
• Export CSV （导出 CSV）
• Show/hide columns （显示/隐藏列）
• Loading （加载中）
• Format content （格式化内容）
• Custom column template （自定义模板）
• Context menu（快捷菜单）
• Virtual Scroller（可视渲染）
• Expandable row （展开行）
• Pager（分页）
• Toolbar（工具栏）
• Tree table （树形表格)
• Editable CRUD（增删改查)
• Editable validate（数据校验）
• DataProxy（数据代理）
• Keyboard navigation（全键盘操作）
• Excel（Excel 表格）

Docs

To view the example 查看演示
To view the document 查看文档

Installing

require: Vue 2.6+

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'
})

Theme

Case 1. Use the default theme style.
使用默认的主题样式

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

Case 2. Modify the table theme color.
修改表格主题颜色

// 引入变量
@import 'vxe-table/src/style/variable.scss';
// 局部覆盖
$vxe-font-color: #606266;
$vxe-table-header-background-color: #f8f8f9;
$vxe-table-border-color: #e8eaec;
$vxe-table-background-color: #ffffff;
// 引入样式
@import 'vxe-table/src/style/default.scss';

Case 3. If you need to completely rewrite the theme style, Copy the vxe-table/src/style directory into the project and modify it yourself.
如果需要完全重写主题样式，只需复制 vxe-table/src/style 目录到项目中自行修改就行（例如复制到 /assets）

@import 'assets/style/index.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/en'

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')

Plugins

• vxe-table-plugin-element For integration element-ui components.
• vxe-table-plugin-iview For integration iview components.
• vxe-table-plugin-antd For integration ant-design-vue components.

Example

<template>
  <div>
    <vxe-table ref="xTable" :data.sync="tableData">
      <vxe-table-column type="index" label="Number" width="80"></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,
          name: 'test1',
          role: 'developer',
          sex: 'Man',
          address: 'address abc123'
        }
      ]
    }
  }
}
</script>

Donation

If the project is very helpful to you, you can buy the author a cup of coffee.
如果这个项目对您有帮助，请作者喝杯咖啡吧。☕

License

Copyright (c) 2019-present, Xu Liangzhan