一、开源项目简介

一个基于 vue 的 PC 端表格组件，支持增删改查、虚拟列表、虚拟树、懒加载、快捷菜单、数据校验、打印导出、表单渲染、数据分页、弹窗、自定义模板、渲染器、贼灵活的配置项等...

• 设计理念
• 面向现代浏览器，高效的简洁 API 设计
• 模块化表格、按需加载
• 为单行编辑表格而设计，支持增删改查及更多扩展，强大的功能的同时兼具性能

二、开源协议

使用MIT开源协议

三、界面展示

四、功能概述

浏览器支持

80+ ✔

80+ ✔

90+ ✔

75+ ✔

10+ ✔

功能点

• 基础表格
• 高级表格
• 斑马线条纹
• 多种边框
• 单元格样式
• 列宽拖动
• 最大高度
• 自适应宽高
• 固定列
• 多级表头
• 表尾数据
• 高亮行或列
• 序号
• 单选框
• 复选框
• 下拉选项
• 开关
• 排序
• 多字段组合排序
• 筛选
• 合并单元格
• 合并表尾
• 导入/导出/打印
• 显示/隐藏列
• 加载中
• 格式化内容
• 自定义插槽 - 模板
• 快捷菜单
• 展开行
• 分页
• 表单
• 工具栏
• 下拉容器
• 虚拟列表
• 虚拟树
• 增删改查
• 数据校验
• 数据代理
• 键盘导航
• 弹窗
• 渲染器
• 虚拟滚动
• 虚拟合并
• (pro) 单元格区域选取
• (pro) 单元格复制/粘贴
• (pro) 单元格查找和替换

五、技术选型

推荐使用 npm 的方式安装，它能更好地和 webpack、vite 等打包工具配合使用。

依赖库：xe-utils vue 3.2+

安装

版本：vue 3.x, 依赖库：xe-utils

npm install xe-utils vxe-table@next

Get on unpkg and cdnjs

npm

import { createApp } from 'vue'
import 'xe-utils'
import VXETable from 'vxe-table'
import 'vxe-table/lib/style.css'

createApp(App).use(VXETable).mount('#app')

CDN

不建议将第三方的 CDN 地址用于生产，因为该连接随时都可能会失效，导致项目挂掉;

使用 CDN 方式记得锁定版本号，避免受到非兼容性更新的影响

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

示例

<template>
  <div>
    <vxe-table :data="tableData">
      <vxe-column type="seq" title="Seq" width="60"></vxe-column>
      <vxe-column field="name" title="Name"></vxe-column>
      <vxe-column field="role" title="Role"></vxe-column>
      <vxe-colgroup title="Group1">
        <vxe-column field="sex" title="Sex"></vxe-column>
        <vxe-column field="address" title="Address"></vxe-column>
      </vxe-colgroup>
    </vxe-table>
  </div>
</template>

<script lang="ts">
import { defineComponent, ref } from 'vue'

export default defineComponent({
  setup () {
    const tableData = ref([
      { id: 10001, name: 'Test1', role: 'Develop', sex: 'Man', address: 'Shenzhen' },
      { id: 10002, name: 'Test2', role: 'Test', sex: 'Man', address: 'Guangzhou' },
      { id: 10003, name: 'Test3', role: 'PM', sex: 'Man', address: 'Shanghai' }
    ])
    return {
      tableData
    }
  }
})
</script>

文档

以下内容详见 README.md 文档：

使用指南

查看文档

运行项目

安装依赖

npm run update
启动本地调试

npm run serve

编译打包，生成编译后的目录：es,lib

npm run lib