261 lines
9.7 KiB
Markdown
261 lines
9.7 KiB
Markdown
# vxe-table
|
||
|
||
简体中文 | [繁體中文](README.zh-TW.md) | [English](README.en.md) | [日本語](README.ja-JP.md)
|
||
|
||
[](https://github.com/x-extends/vxe-table/stargazers)
|
||
[](https://gitee.com/x-extends/vxe-table/stargazers)
|
||
[](https://gitcode.com/x-extends/vxe-table/stargazers)
|
||
[](https://github.com/x-extends/vxe-table/actions/workflows/webpack.yml)
|
||
[](https://npm-stat.com/charts.html?package=vxe-table)
|
||
[](https://github.com/x-extends/vxe-table/issues)
|
||
[](https://github.com/x-extends/vxe-table/issues?q=is%3Aissue+is%3Aclosed)
|
||
[](https://github.com/x-extends/vxe-table/pulls)
|
||
[](https://github.com/x-extends/vxe-table/pulls?q=is%3Apr+is%3Aclosed)
|
||
[](LICENSE)
|
||
|
||
一个基于 [Vxe UI](https://github.com/x-extends/vxe-pc-ui) 的 PC 端表格组件，支持增删改查的可编辑表格，支持复制粘贴、数据透视表、虚拟列表高性能的企业级表格解决方案
|
||
|
||
* 设计理念
|
||
* 面向现代浏览器，不支持 IE
|
||
* 双向数据流的设计，在渲染器或自定义扩展中支持直接操作数据值，达到最高效的简洁 API 设计
|
||
* 按需加载、自定义主题样式
|
||
|
||
* 版本说明
|
||
* **V4**
|
||
* [x] v3.16 适配 Gantt 甘特图
|
||
* [x] v3.15 优化虚拟渲染，降低内存的占用率
|
||
* [x] v4.14 重构虚拟渲染，提高渲染与拖拽效果流畅度
|
||
* [x] v4.13 优化虚拟渲染，提升 Chrome、Safari、Firefox 流畅度极兼容性
|
||
* [x] v4.12 重构虚拟渲染，支持百万级数据渲染、渲染性能及流畅度大幅提升
|
||
* [x] v4.11 重构展开行功能，同时支持展开行与虚拟渲染和冻结列
|
||
* [x] v4.7 基于 vue3.2+，内部重构，拆分 Table 库和 UI 库，只支持现代浏览器，不支持 IE
|
||
* [x] ~~v4.0 基于 vue3.2+，只支持现代浏览器，不支持 IE（2020-03-01 ~ 2024-12-01 已停止维护）~~
|
||
* **V3**
|
||
* [x] v3.18 适配 Gantt 甘特图
|
||
* [x] v3.17 优化虚拟渲染，降低内存的占用率
|
||
* [x] v3.16 重构虚拟渲染，提高渲染与拖拽效果流畅度
|
||
* [x] v3.15 优化虚拟渲染，提升 Chrome、Safari、Firefox 流畅度极兼容性
|
||
* [x] v3.14 重构虚拟渲染，支持百万级数据渲染、渲染性能及流畅度大幅提升
|
||
* [x] v3.13 重构展开行功能，同时支持展开行与虚拟渲染和冻结列
|
||
* [x] v3.9 基于 vue2.6~2.7，内部重构，拆分 Table 库和 UI 库，只支持现代浏览器，不支持 IE
|
||
* [x] ~~v3.0 基于 vue2.6~2.7，支持现代浏览器并保留兼容 IE11（2020-03-01 ~ 2024-12-01 已停止维护）~~
|
||
* **V2**
|
||
* [x] ~~v2.0 基于 vue2.6~2.7，支持所有主流的浏览器，同时兼具功能与性能（2019-03-01 ~ 2021-12-01 已停止维护）~~
|
||
* **V1**
|
||
* [x] ~~v1.0 基于 vue2.6~2.7，支持所有主流的浏览器，实现表格的一切实用的功能（2018-02-01 ~ 2020-04-01 已停止维护）~~
|
||
* 版本计划
|
||
* [x] 优化展开行与冻结列
|
||
* [ ] 优化虚拟渲染，支持千万级数据渲染
|
||
* [ ] 数据图表可视化
|
||
|
||
## 浏览器支持
|
||
|
||
 |  |  |  | 
|
||
--- | --- | --- | --- | --- |
|
||
80+ ✔ | 80+ ✔ | 90+ ✔ | 75+ ✔ | 10+ ✔ |
|
||
|
||
## 在线文档
|
||
|
||
👉 [基础库](https://vxeui.com)
|
||
👉 [表格库](https://vxetable.cn)
|
||
👉 [甘特图](https://gantt.vxeui.com)
|
||
👉 [可视化](https://design.vxeui.com)
|
||
|
||
## QQ 交流群
|
||
|
||
该群供大家交流問題，如果群人数已满，将会不定期剔除不活跃的。
|
||
|
||
|
||
|
||
|
||
## 功能点
|
||
|
||
* [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] CSS 变量主题
|
||
* [x] ([企业版](https://vxetable.cn/pluginDocs/)) 数据汇总
|
||
* [x] ([企业版](https://vxetable.cn/pluginDocs/)) 聚合函数
|
||
* [x] ([企业版](https://vxetable.cn/pluginDocs/)) 单元格区域选取
|
||
* [x] ([企业版](https://vxetable.cn/pluginDocs/)) 单元格复制/粘贴
|
||
* [x] ([企业版](https://vxetable.cn/pluginDocs/)) 单元格查找和替换
|
||
* [x] ([企业版](https://vxetable.cn/pluginDocs/)) 全键盘操作
|
||
* [x] ([企业版](https://vxetable.cn/pluginDocs/)) 集成图表
|
||
|
||
## 安装
|
||
|
||
版本：[vue](https://www.npmjs.com/package/vue) 3.x
|
||
|
||
```shell
|
||
npm install vxe-table
|
||
```
|
||
|
||
Get on [unpkg](https://unpkg.com/vxe-table/) and [cdnjs](https://cdn.jsdelivr.net/npm/vxe-table/)
|
||
|
||
|
||
### NPM
|
||
|
||
```javascript
|
||
// ...
|
||
import VxeUITable from 'vxe-table'
|
||
import 'vxe-table/lib/style.css'
|
||
// ...
|
||
|
||
createApp(App).use(VxeUITable).mount('#app')
|
||
```
|
||
|
||
### CDN
|
||
|
||
使用第三方 CDN 方式记得锁定版本号，避免受到非兼容性更新的影响
|
||
***不建议将第三方的 CDN 地址用于正式环境，因为该连接随时都可能会失效***
|
||
|
||
```HTML
|
||
<!DOCTYPE html>
|
||
<html>
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta http-equiv="Cache-Control" content="no-cache, no-store, must-revalidate">
|
||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||
<!-- style -->
|
||
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/vxe-pc-ui@4/lib/style.css">
|
||
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/vxe-table@4/lib/style.css">
|
||
<!-- vue -->
|
||
<script src="https://cdn.jsdelivr.net/npm/vue@3"></script>
|
||
<!-- table -->
|
||
<script src="https://cdn.jsdelivr.net/npm/xe-utils"></script>
|
||
<script src="https://cdn.jsdelivr.net/npm/vxe-pc-ui@4"></script>
|
||
<script src="https://cdn.jsdelivr.net/npm/vxe-table@4"></script>
|
||
</head>
|
||
<body>
|
||
<div id="app">
|
||
<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>
|
||
</div>
|
||
<script>
|
||
(function () {
|
||
var App = {
|
||
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' }
|
||
]
|
||
}
|
||
}
|
||
}
|
||
Vue.createApp(App).use(VxeUI).use(VXETable).mount('#app')
|
||
})()
|
||
</script>
|
||
</body>
|
||
</html>
|
||
```
|
||
|
||
## 示例
|
||
|
||
```html
|
||
<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>
|
||
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>
|
||
```
|
||
|
||
## 运行项目
|
||
|
||
安装依赖
|
||
|
||
```shell
|
||
npm run update
|
||
```
|
||
|
||
启动本地调试
|
||
|
||
```shell
|
||
npm run serve
|
||
```
|
||
|
||
编译打包，生成编译后的目录：es,lib
|
||
|
||
```shell
|
||
npm run lib
|
||
```
|
||
|
||
## Contributors
|
||
|
||
Thank you to everyone who contributed to this project.
|
||
|
||
[](https://github.com/x-extends/vxe-table/graphs/contributors)
|
||
|
||
## License
|
||
|
||
[MIT](LICENSE) © 2019-present, Xu Liangzhan
|