mirror of
https://gitee.com/xuliangzhan_admin/vxe-table.git
synced 2026-01-21 05:27:57 +08:00
188 lines
15 KiB
Markdown
188 lines
15 KiB
Markdown
# vxe-table
|
||
|
||
[](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) 的表格组件，支持增删改查、虚拟滚动、懒加载、快捷菜单、数据校验、树形结构、打印导出、表单渲染、数据分页、模态窗口、自定义模板、贼灵活的配置项、丰富的扩展插件等...
|
||
|
||
* 设计理念
|
||
* 面向现代浏览器，高效的简洁 API 设计
|
||
* 模块化表格、按需加载、插件化扩展
|
||
* 为单行编辑表格而设计，支持增删改查及更多扩展，强大的功能的同时兼具性能
|
||
|
||
* 计划
|
||
* [x] v1.0 100% 实现表格的一切实用的功能
|
||
* [x] v2.0 95% 性能优化，同时兼具功能与性能
|
||
* [ ] v3.0 0% 内部重构，不再支持 IE，渲染性能提升
|
||
* [ ] v4.0 0% 基于 Vue3 重构，渲染性能提升
|
||
|
||
🐬 如果有更好的建议、优化点或 Bug 都欢迎提 [Issues](https://github.com/xuliangzhan/vxe-table/issues/390)
|
||
|
||
## Browser Support
|
||
|
||
 |  |  |  |  | 
|
||
--- | --- | --- | --- | --- | --- |
|
||
11+ ✔ | Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ |
|
||
|
||
## Features
|
||
|
||
* [x] Basic table （基础表格）
|
||
* [x] Grid （高级表格）
|
||
* [x] Size （尺寸）
|
||
* [x] Striped （斑马线条纹）
|
||
* [x] Table with border （带边框）
|
||
* [x] Cell style （单元格样式）
|
||
* [x] Column resizable （列宽拖动）
|
||
* [x] Maximum table height （最大高度）
|
||
* [x] Resize height and width （响应式宽高）
|
||
* [x] Fixed column （固定列）
|
||
* [x] Grouping table head （表头分组）
|
||
* [x] Highlight row and column （高亮行、列)
|
||
* [x] Table sequence （序号)
|
||
* [x] Radio （单选)
|
||
* [x] Checkbox （多选）
|
||
* [x] Sorting （排序）
|
||
* [x] Filter （筛选）
|
||
* [x] Rowspan and colspan （合并行或列）
|
||
* [x] Footer summary （表尾合计）
|
||
* [x] Import （导入)
|
||
* [x] Export （导出)
|
||
* [x] Print （打印)
|
||
* [x] Show/Hide column （显示/隐藏列）
|
||
* [x] Loading （加载中）
|
||
* [x] Formatted content （格式化内容）
|
||
* [x] Custom template （自定义模板）
|
||
* [x] Context menu（快捷菜单）
|
||
* [x] Virtual Scroller（虚拟滚动）
|
||
* [x] Expandable row （展开行）
|
||
* [x] Pager（分页）
|
||
* [x] Form（表单）
|
||
* [x] Toolbar（工具栏）
|
||
* [x] Tree table （树形表格)
|
||
* [x] Editable CRUD（增删改查)
|
||
* [x] Validate（数据校验）
|
||
* [x] Data Proxy（数据代理）
|
||
* [x] Keyboard navigation（键盘导航）
|
||
* [x] Modal window（模态窗口）
|
||
* [x] Charts（图表工具）
|
||
|
||
## Modules
|
||
|
||
* Core (核心)
|
||
*  (表格)
|
||
* Modules （可选模块）
|
||
*  （图标）
|
||
*  （表头）
|
||
*  （表尾）
|
||
*  （筛选）
|
||
*  （加载中）
|
||
*  （提示信息）
|
||
*  （快捷菜单）
|
||
*  （导出）
|
||
*  （按键导航）
|
||
*  （响应式）
|
||
* Component （可选组件）
|
||
*  （高级表格）
|
||
*  （静态列）
|
||
*  （表单）
|
||
*  （分页）
|
||
*  （工具栏）
|
||
*  （复选框）
|
||
*  （单选框）
|
||
*  （输入框）
|
||
*  （模态窗口）
|
||
*  （按钮）
|
||
* Plugins（插件）
|
||
* 增强插件
|
||
* [](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-charts) ([图表插件](https://www.npmjs.com/package/vxe-table-plugin-charts))
|
||
* [](https://www.npmjs.org/package/vxe-table-plugin-shortcut-key) ([快捷键插件](https://www.npmjs.com/package/vxe-table-plugin-shortcut-key))
|
||
* 适配插件
|
||
* [](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))
|
||
|
||
## Docs
|
||
|
||
[To view the user guide 使用指南](https://github.com/xuliangzhan/vxe-table-demo)
|
||
|
||
[To view the example](https://xuliangzhan.github.io/vxe-table/#/table/base/basic) [查看演示](https://xuliangzhan_admin.gitee.io/vxe-table/#/table/base/basic)
|
||
[To view the document](https://xuliangzhan.github.io/vxe-table/#/table/api) [查看文档](https://xuliangzhan_admin.gitee.io/vxe-table/#/table/api)
|
||
|
||
## Installing
|
||
|
||
依赖库：[vue](https://www.npmjs.com/package/vue) 2.6+, [xe-utils](https://www.npmjs.com/package/xe-utils) 2.2+
|
||
|
||
```shell
|
||
npm install xe-utils vxe-table
|
||
```
|
||
|
||
Get on [unpkg](https://unpkg.com/vxe-table/) and [cdnjs](https://cdn.jsdelivr.net/npm/vxe-table/)
|
||
|
||
```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>
|
||
```
|
||
|
||
```javascript
|
||
import Vue from 'vue'
|
||
import 'xe-utils'
|
||
import VXETable from 'vxe-table'
|
||
import 'vxe-table/lib/index.css'
|
||
|
||
Vue.use(VXETable)
|
||
```
|
||
|
||
## Example
|
||
|
||
```html
|
||
<template>
|
||
<div>
|
||
<vxe-table :data="tableData">
|
||
<vxe-table-column type="seq" title="Sequence number" width="80"></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>
|
||
```
|
||
|
||
## Donation
|
||
|
||
If the open source project is very helpful to you, you can buy the author a cup of coffee.
|
||
如果这个开源项目对您有帮助，请作者喝杯咖啡吧。☕
|
||
|
||
|
||
|
||
## License
|
||
|
||
MIT License, 2019-present, Xu Liangzhan
|