by2025/admin-vben5
9
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

docs: vbenVxeTable slots docs update

Browse Source
This commit is contained in:
Netfan 2025-03-01 22:12:15 +08:00
parent 5ea6b4a8d8
commit e815f0ff89
1 changed files with 19 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
docs/src/components/common-ui/vben-vxe-table.md
View File

@ -231,12 +231,22 @@ useVbenVxeGrid 返回的第二个参数，是一个对象，包含了一些表
所有属性都可以传入 `useVbenVxeGrid` 的第一个参数中。 所有属性都可以传入 `useVbenVxeGrid` 的第一个参数中。
| 属性名 | 描述 | 类型 | | 属性名 | 描述 | 类型 |
| -------------- | ------------------ | ------------------- | | -------------- | -------------------- | ------------------- |
| tableTitle | 表格标题 | `string` | | tableTitle | 表格标题 | `string` |
| tableTitleHelp | 表格标题帮助信息 | `string` | | tableTitleHelp | 表格标题帮助信息 | `string` |
| gridClass | grid组件的class | `string` | | gridClass | grid组件的class | `string` |
| gridOptions | grid组件的参数 | `VxeTableGridProps` | | gridOptions | grid组件的参数 | `VxeTableGridProps` |
| gridEvents | grid组件的触发的⌚️ | `VxeGridListeners` | | gridEvents | grid组件的触发的事件 | `VxeGridListeners` |
| formOptions | 表单参数 | `VbenFormProps` | | formOptions | 表单参数 | `VbenFormProps` |
| showSearchForm | 是否显示搜索表单 | `boolean` | | showSearchForm | 是否显示搜索表单 | `boolean` |
## Slots
大部分插槽的说明请参考 [vxe-table 官方文档](https://vxetable.cn/v4/#/grid/api)，但工具栏部分由于做了一些定制封装，需使用以下插槽定制表格的工具栏：
| 插槽名 | 描述 |
| --------------- | -------------------------------------------- |
| toolbar-actions | 工具栏左侧部分（表格标题附近） |
| toolbar-tools | 工具栏右侧部分（vxeTable原生工具按钮的左侧） |
| table-title | 表格标题插槽 |