119 lines
4.7 KiB
Markdown
119 lines
4.7 KiB
Markdown
# vxe-table
|
|
|
|
[简体中文](README.md) | [繁體中文](README.zh-TW.md) | English | [日本語](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://www.npmjs.com/package/vxe-table)
|
|
[](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)
|
|
|
|
A PC-end table component based on [Vxe UI](https://github.com/x-extends/vxe-pc-ui), enterprise-level table solution with support for copy-paste, data pivot tables, and virtual lists, featuring high performance.
|
|
|
|
## Browser Support
|
|
|
|
 |  |  |  | 
|
|
--- | --- | --- | --- | --- |
|
|
Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ |
|
|
|
|
## 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 VxeUITable from 'vxe-table'
|
|
import 'vxe-table/lib/style.css'
|
|
// ...
|
|
|
|
createApp(App).use(VxeUITable).mount('#app')
|
|
```
|
|
|
|
### CDN
|
|
|
|
Use a third-party CDN to remember to lock the version number to avoid being affected by incompatible updates.
|
|
***It is not recommended to use the CDN address of a third party in a formal environment because the connection can fail at any time***
|
|
|
|
```HTML
|
|
<!-- style -->
|
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/vxe-pc-ui/lib/style.css">
|
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/vxe-table@next/lib/style.css">
|
|
<!-- vue -->
|
|
<script src="https://cdn.jsdelivr.net/npm/vue"></script>
|
|
<!-- table -->
|
|
<script src="https://cdn.jsdelivr.net/npm/xe-utils"></script>
|
|
<script src="https://cdn.jsdelivr.net/npm/vxe-pc-ui"></script>
|
|
<script src="https://cdn.jsdelivr.net/npm/vxe-table@next"></script>
|
|
```
|
|
|
|
## Example
|
|
|
|
```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 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
|
|
|
|
👉 [UI Document](https://vxeui.com)
|
|
👉 [Table Document](https://vxetable.cn)
|
|
|
|
## Run the project
|
|
|
|
Install dependencies
|
|
|
|
```shell
|
|
npm run update
|
|
```
|
|
|
|
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
|