Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/x-extends/vxe-table

vxe-table vue 表单/表格解决方案
https://github.com/x-extends/vxe-table

cell checkbox editable form grid input modal pager radio select switch table toolbar vue vue-table vxe-grid vxe-table

Last synced: 3 months ago
JSON representation

vxe-table vue 表单/表格解决方案

Lists

README 

        
# vxe-table



[简体中文](README.md) | [繁體中文](README.zh-TW.md) | English  



[![star](https://gitee.com/xuliangzhan_admin/vxe-table/badge/star.svg?theme=gvp)](https://gitee.com/xuliangzhan_admin/vxe-table/stargazers)

[![npm version](https://img.shields.io/npm/v/vxe-table.svg?style=flat-square)](https://www.npmjs.com/package/vxe-table)

[![npm build](https://travis-ci.com/x-extends/vxe-table.svg?branch=master)](https://travis-ci.com/x-extends/vxe-table)

[![npm downloads](https://img.shields.io/npm/dt/vxe-table.svg?style=flat-square)](https://npm-stat.com/charts.html?package=vxe-table)

[![issues](https://img.shields.io/github/issues/x-extends/vxe-table.svg)](https://github.com/x-extends/vxe-table/issues)

[![issues closed](https://img.shields.io/github/issues-closed/x-extends/vxe-table.svg)](https://github.com/x-extends/vxe-table/issues?q=is%3Aissue+is%3Aclosed)

[![pull requests](https://img.shields.io/github/issues-pr/x-extends/vxe-table.svg)](https://github.com/x-extends/vxe-table/pulls)

[![pull requests closed](https://img.shields.io/github/issues-pr-closed/x-extends/vxe-table.svg)](https://github.com/x-extends/vxe-table/pulls?q=is%3Apr+is%3Aclosed)

[![npm license](https://img.shields.io/github/license/mashape/apistatus.svg)](LICENSE)



A [vue](https://www.npmjs.com/package/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



![Edge](https://raw.github.com/alrra/browser-logos/master/src/edge/edge_48x48.png) | ![Chrome](https://raw.github.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png) | ![Firefox](https://raw.github.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png) | ![Opera](https://raw.github.com/alrra/browser-logos/master/src/opera/opera_48x48.png) | ![Safari](https://raw.github.com/alrra/browser-logos/master/src/safari/safari_48x48.png)

--- | --- | --- | --- | --- |

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](https://www.npmjs.com/package/vue) 3.x



```shell

npm install vxe-table@next

```



Get on [unpkg](https://unpkg.com/vxe-table/) and [cdnjs](https://cdn.jsdelivr.net/npm/vxe-table/)



### npm



```javascript

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***  



```HTML



```



## Example



```html



  


    

      

      

      

      

        

        

      

    

  



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' }

])



```



## Online Documents



👉 [Document](https://vxetable.cn)  



Participate in document improvement and supplement detailed documents.  



💡 [Document source code](https://github.com/x-extends/vxe-table-docs)



## Run the project



Install dependencies



```shell

npm install

```



Start local debugging



```shell

npm run serve

```



Compile packaging, generated compiled directory: es,lib



```shell

npm run lib

```



## License



[MIT](LICENSE) © 2019-present, Xu Liangzhan