199 lines
16 KiB
Markdown
199 lines
16 KiB
Markdown
|
# vxe-table
|
|||
|
|
|
|||
|
|
简体中文 | [English](./README.en.md)
|
|||
|
|
|
|||
|
|
[](https://gitee.com/xuliangzhan_admin/vxe-table/stargazers)
|
|||
|
|
[](https://www.npmjs.org/package/vxe-table)
|
|||
|
|
[](https://travis-ci.org/xuliangzhan/vxe-table)
|
|||
|
|
[](https://npm-stat.com/charts.html?package=vxe-table)
|
|||
|
|
[](https://unpkg.com/vxe-table/lib/index.min.js)
|
|||
|
|
[](https://unpkg.com/vxe-table/lib/index.css)
|
|||
|
|
[](https://github.com/xuliangzhan/vxe-table/issues)
|
|||
|
|
[](https://github.com/xuliangzhan/vxe-table/issues?q=is%3Aissue+is%3Aclosed)
|
|||
|
|
[](https://github.com/xuliangzhan/vxe-table/pulls)
|
|||
|
|
[](https://github.com/xuliangzhan/vxe-table/pulls?q=is%3Apr+is%3Aclosed)
|
|||
|
|
[](https://github.com/xuliangzhan/vxe-table/blob/master/LICENSE)
|
|||
|
|
|
|||
|
|
一个基于 [vue](https://www.npmjs.com/package/vue) 的 PC 端表格组件，支持增删改查、虚拟滚动、懒加载、快捷菜单、数据校验、树形结构、打印导出、表单渲染、数据分页、虚拟列表、模态窗口、自定义模板、渲染器、贼灵活的配置项、扩展接口等...
|
|||
|
|
|
|||
|
|
* 设计理念
|
|||
|
|
* 面向现代浏览器，高效的简洁 API 设计
|
|||
|
|
* 模块化表格、按需加载、扩展接口
|
|||
|
|
* 为单行编辑表格而设计，支持增删改查及更多扩展，强大的功能的同时兼具性能
|
|||
|
|
|
|||
|
|
* [计划](#donation)
|
|||
|
|
* [x] v1.0 100% 基于 vue2.6+，支持所有主流的浏览器，实现表格的一切实用的功能
|
|||
|
|
* [x] v2.0 100% 基于 vue2.6+，支持所有主流的浏览器，同时兼具功能与性能
|
|||
|
|
* [x] v3.0 60% 基于 vue2.6+，只支持 H5 浏览器，不支持 IE，渲染性能大幅提升
|
|||
|
|
* [ ] v4.0 0% 基于 vue3+，只支持 H5 浏览器，不支持 IE，渲染性能大幅提升
|
|||
|
|
|
|||
|
|
👉 如果有更好的建议、优化点或 Bug 都欢迎提 [Issues](https://github.com/xuliangzhan/vxe-table/issues/390)
|
|||
|
|
|
|||
|
|
## 浏览器支持
|
|||
|
|
|
|||
|
|
 |  |  |  |  | 
|
|||
|
|
--- | --- | --- | --- | --- | --- |
|
|||
|
|
11+ ✔ | Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ |
|
|||
|
|
|
|||
|
|
## 功能点
|
|||
|
|
|
|||
|
|
* [x] 基础表格
|
|||
|
|
* [x] 高级表格
|
|||
|
|
* [x] 斑马线条纹
|
|||
|
|
* [x] 多种边框
|
|||
|
|
* [x] 单元格样式
|
|||
|
|
* [x] 列宽拖动
|
|||
|
|
* [x] 最大高度
|
|||
|
|
* [x] 自适应宽高
|
|||
|
|
* [x] 固定列
|
|||
|
|
* [x] 多级表头
|
|||
|
|
* [x] 表尾数据
|
|||
|
|
* [x] 高亮行、列
|
|||
|
|
* [x] 序号
|
|||
|
|
* [x] 单选框
|
|||
|
|
* [x] 复选框
|
|||
|
|
* [x] 下拉选项
|
|||
|
|
* [x] 开关
|
|||
|
|
* [x] 排序
|
|||
|
|
* [x] 筛选
|
|||
|
|
* [x] 合并行或列
|
|||
|
|
* [x] 导入
|
|||
|
|
* [x] 导出
|
|||
|
|
* [x] 打印
|
|||
|
|
* [x] 显示/隐藏列
|
|||
|
|
* [x] 加载中
|
|||
|
|
* [x] 格式化内容
|
|||
|
|
* [x] 自定义插槽/模板
|
|||
|
|
* [x] 快捷菜单
|
|||
|
|
* [x] 展开行
|
|||
|
|
* [x] 分页
|
|||
|
|
* [x] 表单
|
|||
|
|
* [x] 工具栏
|
|||
|
|
* [x] 下拉容器
|
|||
|
|
* [x] 虚拟列表
|
|||
|
|
* [x] 增删改查
|
|||
|
|
* [x] 树表格
|
|||
|
|
* [x] 数据校验
|
|||
|
|
* [x] 数据代理
|
|||
|
|
* [x] 键盘导航
|
|||
|
|
* [x] 模态窗口
|
|||
|
|
* [x] 渲染器
|
|||
|
|
* [x] 虚拟滚动
|
|||
|
|
|
|||
|
|
## 模块&组件
|
|||
|
|
|
|||
|
|
* 核心
|
|||
|
|
*  (表格)
|
|||
|
|
* 可选模块
|
|||
|
|
*  （图标）
|
|||
|
|
*  （表头）
|
|||
|
|
*  （表尾）
|
|||
|
|
*  （筛选）
|
|||
|
|
*  （提示信息）
|
|||
|
|
*  （快捷菜单）
|
|||
|
|
*  （导出）
|
|||
|
|
*  （按键导航）
|
|||
|
|
* 可选组件
|
|||
|
|
*  （高级表格）
|
|||
|
|
*  （静态列）
|
|||
|
|
*  （虚拟列表）
|
|||
|
|
*  （表单）
|
|||
|
|
*  （分页）
|
|||
|
|
*  （工具栏）
|
|||
|
|
*  （复选框）
|
|||
|
|
*  （单选框）
|
|||
|
|
*  （输入框）
|
|||
|
|
*  （下拉框）
|
|||
|
|
*  （开关）
|
|||
|
|
*  （模态窗口）
|
|||
|
|
*  （按钮）
|
|||
|
|
*  （下拉容器）
|
|||
|
|
* 可选插件
|
|||
|
|
* 增强插件
|
|||
|
|
* [](https://www.npmjs.org/package/vxe-table-plugin-export-pdf) ([PDF 导出插件](https://www.npmjs.com/package/vxe-table-plugin-export-pdf))
|
|||
|
|
* [](https://www.npmjs.org/package/vxe-table-plugin-export-xlsx) ([XLSX 导出插件](https://www.npmjs.com/package/vxe-table-plugin-export-xlsx))
|
|||
|
|
* [](https://www.npmjs.org/package/vxe-table-plugin-menus) ([快捷菜单插件](https://www.npmjs.com/package/vxe-table-plugin-menus))
|
|||
|
|
* 适配插件
|
|||
|
|
* [](https://www.npmjs.org/package/vxe-table-plugin-element) ([element-ui 适配插件](https://www.npmjs.org/package/vxe-table-plugin-element))
|
|||
|
|
* [](https://www.npmjs.org/package/vxe-table-plugin-iview) ([iview 适配插件](https://www.npmjs.org/package/vxe-table-plugin-iview))
|
|||
|
|
* [](https://www.npmjs.org/package/vxe-table-plugin-antd) ([ant-design-vue 适配插件](https://www.npmjs.org/package/vxe-table-plugin-antd))
|
|||
|
|
|
|||
|
|
## 安装
|
|||
|
|
|
|||
|
|
依赖库：[vue](https://www.npmjs.com/package/vue) 2.6+, [xe-utils](https://www.npmjs.com/package/xe-utils) 2.4+
|
|||
|
|
|
|||
|
|
```shell
|
|||
|
|
npm install xe-utils vxe-table
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
Get on [unpkg](https://unpkg.com/vxe-table/) and [cdnjs](https://cdn.jsdelivr.net/npm/vxe-table/)
|
|||
|
|
|
|||
|
|
### npm
|
|||
|
|
|
|||
|
|
```javascript
|
|||
|
|
import Vue from 'vue'
|
|||
|
|
import 'xe-utils'
|
|||
|
|
import VXETable from 'vxe-table'
|
|||
|
|
import 'vxe-table/lib/index.css'
|
|||
|
|
|
|||
|
|
Vue.use(VXETable)
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### CDN
|
|||
|
|
|
|||
|
|
```HTML
|
|||
|
|
<!-- 引入样式 -->
|
|||
|
|
<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>
|
|||
|
|
<!-- 建议使用 CDN 方式引入的用户在链接地址上锁定版本，避免受到非兼容性更新的影响 -->
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## 示例
|
|||
|
|
|
|||
|
|
```html
|
|||
|
|
<template>
|
|||
|
|
<div>
|
|||
|
|
<vxe-table :data="tableData">
|
|||
|
|
<vxe-table-column type="seq" title="Seq" width="60"></vxe-table-column>
|
|||
|
|
<vxe-table-column field="name" title="Name"></vxe-table-column>
|
|||
|
|
<vxe-table-column field="sex" title="Sex"></vxe-table-column>
|
|||
|
|
<vxe-table-column field="address" title="Address"></vxe-table-column>
|
|||
|
|
</vxe-table>
|
|||
|
|
</div>
|
|||
|
|
</template>
|
|||
|
|
|
|||
|
|
<script>
|
|||
|
|
export default {
|
|||
|
|
data () {
|
|||
|
|
return {
|
|||
|
|
tableData: [
|
|||
|
|
{ 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' }
|
|||
|
|
]
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</script>
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## 文档说明
|
|||
|
|
|
|||
|
|
[💡 使用指南](https://github.com/xuliangzhan/vxe-table-demo)
|
|||
|
|
[👉 查看演示](https://xuliangzhan_admin.gitee.io/vxe-table/#/table/base/basic)
|
|||
|
|
[👉 查看文档](https://xuliangzhan_admin.gitee.io/vxe-table/#/table/api)
|
|||
|
|
|
|||
|
|
## Donation
|
|||
|
|
|
|||
|
|
如果这个开源项目对您有帮助，请作者喝杯咖啡吧。☕
|
|||
|
|
有问题欢迎留言或者提 [Issues](https://github.com/xuliangzhan/vxe-table/issues/390)
|
|||
|
|
|
|||
|
|
由于维护一个开源项目需要花费非常大的精力与时间，如果您正在使用该项目，您的捐赠会帮助该项目能持续发展下去
|
|||
|
|
[👉 捐赠方式💰](https://xuliangzhan_admin.gitee.io/vxe-table/#/donation/api)
|
|||
|
|
|
|||
|
|
## License
|
|||
|
|
|
|||
|
|
[MIT License](./LICENSE), 2019-present, [Xu Liangzhan](mailto:xu_liangzhan@163.com)
|