2026-03-25 13:32:21 +08:00
|
|
|
# VXE Table Plugin
|
|
|
|
|
|
|
|
|
|
基于 vxe-table 和 vxe-pc-ui 的表格组件插件。
|
|
|
|
|
|
|
|
|
|
## 导出
|
|
|
|
|
|
2026-03-25 16:33:24 +08:00
|
|
|
| 导出 | 类型 | 说明 |
|
|
|
|
|
| --------------------- | ---- | -------------- |
|
|
|
|
|
| `setupVbenVxeTable` | 函数 | 初始化配置函数 |
|
|
|
|
|
| `useVbenVxeGrid` | 函数 | 表格组合式函数 |
|
|
|
|
|
| `VbenVxeGrid` | 组件 | 表格组件 |
|
|
|
|
|
| `VxeTableGridColumns` | 类型 | 表格列类型 |
|
|
|
|
|
| `VxeTableGridOptions` | 类型 | 表格配置类型 |
|
|
|
|
|
| `VxeGridProps` | 类型 | 表格 Props |
|
|
|
|
|
| `VxeGridListeners` | 类型 | 表格事件类型 |
|
2026-03-25 13:32:21 +08:00
|
|
|
|
|
|
|
|
## 使用
|
|
|
|
|
|
|
|
|
|
```ts
|
2026-03-25 16:33:24 +08:00
|
|
|
import {
|
|
|
|
|
setupVbenVxeTable,
|
|
|
|
|
useVbenVxeGrid,
|
|
|
|
|
VbenVxeGrid,
|
|
|
|
|
} from '@vben/plugins/vxe-table';
|
2026-03-25 13:32:21 +08:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## 初始化
|
|
|
|
|
|
|
|
|
|
在应用入口处调用:
|
|
|
|
|
|
|
|
|
|
```ts
|
|
|
|
|
import { setupVbenVxeTable } from '@vben/plugins/vxe-table';
|
|
|
|
|
import { useVbenForm } from '@vben-core/form-ui';
|
|
|
|
|
|
|
|
|
|
setupVbenVxeTable({
|
|
|
|
|
configVxeTable: (vxeUI) => {
|
|
|
|
|
// 配置 VXE Table
|
|
|
|
|
},
|
|
|
|
|
useVbenForm,
|
|
|
|
|
});
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## 类型
|
|
|
|
|
|
|
|
|
|
```ts
|
2026-03-25 16:33:24 +08:00
|
|
|
import type {
|
|
|
|
|
VxeTableGridOptions,
|
|
|
|
|
VxeGridProps,
|
|
|
|
|
} from '@vben/plugins/vxe-table';
|
|
|
|
|
```
|