vxe-table

简体中文 | 繁體中文 | English

A vue based PC form component, support add, delete, change, virtual list, virtual tree, lazy load, shortcut menu, data validation, print export, form rendering, data paging, modal window, custom template, renderer, JSON configuration...

• Design concept

  • Efficient and concise API design for modern browsers.
  • Modular tables, on-demand loading.
  • Designed for single row table editing, supports addition, deletion, modification and query as well as more expansion, with powerful functions and performance at the same time.

• Plan

  • [x] ~~v1.0 Based on vue2.6, Support for all major browsers.~~
  • [x] ~~v2.0 Based on vue2.6, Support for all major browsers.~~
  • [x] v3.0 Based on vue2.6, supports modern browsers and retains compatibility with IE11.
  • [x] v4.0 Based on vue3.x, Only support modern browser, not IE.

Browser Support

| | | | --- | --- | --- | --- | --- | Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ |

Features

• [x] Basic table
• [x] Configuration grid
• [x] Base form
• [x] Configuration form
• [x] Striped
• [x] Table with border
• [x] Cell style
• [x] Column resizing
• [x] Minimum/maximum height
• [x] Resize height & width
• [x] Fixed column
• [x] Grouping table header
• [x] Table footer
• [x] Highlight row & column
• [x] Table sequence
• [x] Radio
• [x] Checkbox
• [x] Select
• [x] Switch
• [x] Sorting
• [x] Multi field sorting
• [x] Filter
• [x] Merged cells
• [x] Merged footer items
• [x] Import/Export/Print
• [x] Show/Hide column
• [x] Loading
• [x] Formatted cell
• [x] Slot - template
• [x] Context menu
• [x] Detail - Expandable row
• [x] Pager
• [x] Toolbar
• [x] Pulldown
• [x] Virtual list
• [x] Virtual tree
• [x] Editable CRUD
• [x] Validate
• [x] Data Proxy
• [x] Keyboard navigation
• [x] Modal
• [x] VxeGlobalRenderer
• [x] Virtual scroller
• [x] Virtual merger
• [x] CSS Variable Theme
• [x] (插件) Cell area selection
• [x] (插件) Cell copy & paste
• [x] (插件) Cell find and replace

Installing

Version: vue 3.x

npm install xe-utils vxe-table@next

Get on unpkg and cdnjs

npm

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

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

CDN

Remember to lock the version number in CDN mode to avoid being affected by incompatible updates
It is not recommended to use the CDN address of a third party for production, as the connection may fail at any time

<!-- Style -->
<link rel="stylesheet" href="https://unpkg.com/vxe-table@next/lib/style.css">
<!-- Script -->
<script src="https://unpkg.com/xe-utils"></script>
<script src="https://unpkg.com/vxe-table@next"></script>

Example

<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" setup>
import { ref } from 'vue'

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' }
])
</script>

Online Documents

👉 Document

Participate in document improvement and supplement detailed documents.

💡 Document source code

Run the project

Install dependencies

npm install

Start local debugging

npm run serve

Compile packaging, generated compiled directory: es,lib

npm run lib

License

MIT © 2019-present, Xu Liangzhan