CrudPage 组合页面
组合搜索、表格和共用表单,自动处理查询联动、新增编辑查看和保存后刷新。配置与独立组件完全相同。
基础用法
vue
<template>
<CrudPage
:search-config="searchConfig"
:table-config="tableConfig"
:form-config="formConfig"
:load-form-data="(row) => UserAPI.getFormData(String(row.id))"
/>
</template>完整配置见快速上手示例。
- 省略
searchConfig时不渲染搜索区域 - 省略
formConfig时,新增和行操作通过create、row-action事件交给页面处理 - 首次查询使用搜索字段的
initialValue formConfig.rowKey未指定时沿用tableConfig.rowKey
页面容器
CrudPage 自带 page-container,外层不要再包同名容器。需要侧栏或分栏布局时使用分组件组合。
加载表单详情
列表行缺少表单字段时,配置 loadFormData 在编辑、查看时加载完整详情:
vue
<CrudPage :load-form-data="(row) => UserAPI.getFormData(String(row.id))" ... />列表行已包含全部表单字段时可省略。接口需要保留但不展示的字段,在 fields 中声明 hidden: true,见 CrudForm。
插槽
槽名前缀指定目标组件,其余名称与独立组件一致:
vue
<CrudPage :table-config="tableConfig" :form-config="formConfig">
<template #table-cell-status="{ row }">
<el-tag>{{ row.status === 1 ? "启用" : "禁用" }}</el-tag>
</template>
<template #form-gender="{ formData, prop, attrs }">
<DictSelect v-model="formData[prop]" code="gender" v-bind="attrs" />
</template>
</CrudPage>自定义表单控件需在对应字段配置 type: "custom"。完整槽上下文见 CrudTable 插槽和 CrudForm 插槽。
API
Attributes
| 属性 | 说明 | 类型 | 默认值 |
|---|---|---|---|
| table-config | 列表、按钮和列配置,见 TableConfig | CrudTableConfig | — |
| search-config | 搜索配置,见 SearchConfig | CrudSearchConfig | — |
| form-config | 共用表单配置,见 FormConfig | CrudFormConfig | — |
| load-form-data | 编辑、查看时加载完整详情 | (row) => CrudRecord | Promise<CrudRecord> | — |
Events
| 事件名 | 说明 | 回调参数 |
|---|---|---|
| create | 未配置 formConfig 时点击新增 | — |
| saved | 表单保存成功,组件随后刷新列表 | — |
| toolbar-action | 未配置 onClick 的自定义工具栏动作 | key: string |
| row-action | 内置编辑、查看打开后,或自定义行操作 | { key, row } |
内置删除不触发 row-action
删除由表格直接执行。自定义动作配置 onClick 后由回调处理,不再发出动作事件;需要按钮等待请求完成时使用 onClick,见异步自定义动作。
Slots
| 插槽名 | 说明 | 示例 |
|---|---|---|
| table-* | 转发至 CrudTable | table-cell-status、table-row-action-delete |
| search-* | 转发至 CrudSearch | search-gender、search-label-gender |
| form-* | 转发至 CrudForm | form-gender、form-bottom |
Exposes
| 名称 | 说明 | 类型 |
|---|---|---|
| search | 应用条件并查询第一页,省略参数时读取搜索草稿 | (params?) => Promise<void> |
| resetSearch | 恢复搜索初值、清除表头筛选并查询 | (params?) => Promise<void> |
| refresh | 沿用已应用条件刷新当前页 | () => Promise<void> |
| openCreate | 打开新增表单 | () => void |
| openEdit | 打开编辑表单并加载详情 | (row, loader?) => Promise<void> |
| openView | 打开只读表单并加载详情 | (row, loader?) => Promise<void> |
| exportFile | 执行服务端文件导出 | () => Promise<void> |
| toggleSearch | 切换搜索区域显示 | () => void |
| applyFilters | 应用表头筛选并查询第一页 | () => Promise<void> |
| searchRef / tableRef / formRef | 子组件实例 | Ref |
typescript
const pageRef = ref<InstanceType<typeof CrudPage>>();
// 外部操作完成后刷新列表
await pageRef.value?.refresh();openEdit、openView 默认使用页面的 loadFormData,第二个参数可指定本次打开专用的加载器。
