Skip to content
🐬 vxe-table vue 表格解决方案
JavaScript CSS HTML
Branch: master
Clone or download

README.md

vxe-table

gitee star npm version npm build npm downloads gzip size: JS gzip size: CSS
issues issues closed pull requests pull requests closed npm license

一个基于 vue 的 PC 端表格组件,支持增删改查、虚拟滚动、懒加载、快捷菜单、数据校验、树形结构、打印导出、表单渲染、数据分页、模态窗口、自定义模板、贼灵活的配置项、扩展接口等...

  • 设计理念

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

    • v1.0 100% 实现表格的一切实用的功能
    • v2.0  100% 性能优化,同时兼具功能与性能
    • v3.0   50% 内部重构,不再支持 IE,渲染性能提升
    • v4.0   0% 基于 Vue3 重构,渲染性能提升

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

Browser Support

Edge Chrome Firefox Opera Safari
Latest ✔ Latest ✔ Latest ✔ Latest ✔ Latest ✔

Features

  • Basic table (基础表格)
  • Grid (高级表格)
  • Size (尺寸)
  • Striped (斑马线条纹)
  • Table with border (带边框)
  • Cell style (单元格样式)
  • Column resizable (列宽拖动)
  • Maximum table height (最大高度)
  • Resize height and width (响应式宽高)
  • Fixed column (固定列)
  • Grouping table head (表头分组)
  • Highlight row and column (高亮行、列)
  • Table sequence (序号)
  • Radio (单选)
  • Checkbox (多选)
  • Select (下拉选项)
  • Sorting (排序)
  • Filter (筛选)
  • Rowspan and colspan (合并行或列)
  • Footer summary (表尾合计)
  • Import (导入)
  • Export (导出)
  • Print (打印)
  • Show/Hide column (显示/隐藏列)
  • Loading (加载中)
  • Formatted content (格式化内容)
  • Custom template (自定义模板)
  • Context menu(快捷菜单)
  • Virtual Scroller(虚拟滚动)
  • Expandable row (展开行)
  • Pager(分页)
  • Form(表单)
  • Toolbar(工具栏)
  • Tree table (树形表格)
  • Editable CRUD(增删改查)
  • Validate(数据校验)
  • Data Proxy(数据代理)
  • Keyboard navigation(键盘导航)
  • Modal window(模态窗口)

Modules

  • Core (核心)
    • TableMethodsBodyCellstyle (表格)
  • Modules (可选模块)
    • Icon (图标)
    • Headerstyle (表头)
    • Footerstyle (表尾)
    • FilterPanelstyle (筛选)
    • Tooltipstyle (提示信息)
    • MenuPanelstyle (快捷菜单)
    • Exportstyle (导出)
    • Keyboard (按键导航)
    • ResizeMethods (响应式)
  • Component (可选组件)
    • Gridstyle (高级表格)
    • Column (静态列)
    • FormFormItemstyle (表单)
    • Pagerstyle (分页)
    • Toolbarstyle (工具栏)
    • Checkboxstyle (复选框)
    • Radio style(单选框)
    • Inputstyle (输入框)
    • SelectOptgroupOptionstyle (下拉框)
    • Modalstyle (模态窗口)
    • Buttonstyle (按钮)
  • Plugins(插件)

Docs

To view the user guide 使用指南

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

Installing

依赖库:vue 2.6+, xe-utils 2.4+

npm install xe-utils vxe-table

Get on unpkg and cdnjs

npm

import Vue from 'vue'
import 'xe-utils'
import VXETable from 'vxe-table'
import 'vxe-table/lib/index.css'

Vue.use(VXETable)

CDN

<!-- 引入样式 -->
<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 方式引入的用户在链接地址上锁定版本,避免受到非兼容性更新的影响 -->

Example

<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.
如果这个开源项目对您有帮助,请作者喝杯咖啡吧。☕(如果有问题需要支持可以留言或者提 Issues)

👉 捐赠方式💰

pay

License

MIT License, 2019-present, Xu Liangzhan

You can’t perform that action at this time.