Skip to content

CRUD 进阶 ​

分组件组合、页面方法和导入导出,用于标准 CrudPage 之外的场景。

分组件组合 ​

需要侧栏、分栏或独立工具栏时,直接组合三个组件,用 useCrudPage 连接:

vue
<template>
  <div class="page-container">
    <CrudSearch
      ref="searchRef"
      :search-config="searchConfig"
      @search="search"
      @reset="resetSearch"
    />
    <CrudTable
      ref="tableRef"
      :table-config="tableConfig"
      :auto-load="false"
      @create="openCreate"
      @row-action="handleRowAction"
      @toggle-search="toggleSearch"
      @filter-change="applyFilters"
    />
    <CrudForm ref="formRef" :form-config="formConfig" @saved="refresh" />
  </div>
</template>

<script setup lang="ts">
import { onMounted } from "vue";
import UserAPI from "@/api/system/user";
import type { CrudRowActionEvent } from "@/components/Crud/types";
import useCrudPage from "@/components/Crud/useCrudPage";

const {
  searchRef,
  tableRef,
  formRef,
  search,
  resetSearch,
  refresh,
  openCreate,
  openEdit,
  openView,
  toggleSearch,
  applyFilters,
} = useCrudPage();

// 首次查询使用搜索字段初值
onMounted(() => search());

async function handleRowAction({ key, row }: CrudRowActionEvent): Promise<void> {
  const load = () => UserAPI.getFormData(String(row.id));
  if (key === "edit") await openEdit(row, load);
  else if (key === "view") await openView(row, load);
}
</script>

配置与快速上手示例相同。表格设置 :auto-load="false",由 search() 统一发起首次查询,避免重复请求。

useCrudPage ​

返回值说明
searchRef / tableRef / formRef绑定到三个组件的实例 Ref
search(params?)应用条件并查询第一页,省略时读取搜索草稿
resetSearch(params?)恢复搜索初值、清除表头筛选并查询
refresh()沿用已应用条件刷新当前页
openCreate(target?)打开新增表单
openEdit(row, loader?, target?)打开编辑表单并加载详情
openView(row, loader?, target?)打开只读表单并加载详情
exportFile()执行服务端文件导出
toggleSearch()切换搜索区域
applyFilters()应用表头筛选并查询第一页

loader 接收行并返回表单对象或 Promise。页面有多个业务表单时,用 target 指定目标表单 Ref。

服务端导入导出 ​

typescript
{
  toolbarActions: ["create", "delete", "import", "export"],
  importFile: UserAPI.import,
  importTemplate: UserAPI.downloadTemplate,
  exportFile: UserAPI.export,
}
  • importFile(file) 接收原始 File,支持 .xlsx、.xls
  • importTemplate 为文件 URL 或返回文件响应的异步函数
  • exportFile(query) 返回 AxiosResponse<Blob>,沿用最近成功查询的搜索、筛选和排序,不传分页参数

浏览器导入导出 ​

未配置 exportFile 时,export 打开浏览器导出弹窗,基于 ExcelJS 按需加载生成 .xlsx:

数据来源内容
当前数据当前页
选中数据勾选的行,支持跨页选择
全量数据调用 fetchExportRows(query),未配置时禁用

导出基于原始字段值,不执行 Vue 插槽;需要字典标签等转换时在 fetchExportRows 中处理。大数据量使用服务端导出。

浏览器导入通过 importRows(rows) 接收解析后的对象数组,键来自第一行表头:

json
[{ "用户名": "alice", "昵称": "张三" }]

在回调中完成字段映射和校验,返回批量保存的 Promise。仅解析 .xlsx 第一张工作表,跳过空行;重复表头或无标题的有数据列会报错。

只提供一种回调时自动选择方式;同时提供两种时必须显式指定:

typescript
{
  importMode: "file", // importFile 或 importRows
  exportMode: "file", // exportFile 或浏览器生成
}

导入结果统计 ​

导入回调可返回统计结构,部分成功时显示条数和错误明细:

json
{
  "validCount": 2,
  "invalidCount": 1,
  "messageList": ["第 4 行用户名已存在"]
}

有无效记录时清除已选文件,修正后重新导入;有成功记录时刷新列表。不返回统计时,Promise 完成即成功。

异步自定义动作 ​

onClick 返回 Promise 时,完成前按钮显示加载并禁止重复点击;row-action、toolbar-action 事件不等待监听器的异步结果。写入操作应使用 onClick:

typescript
{
  key: "disable",
  label: "禁用",
  permission: "sys:user:update",
  disabled: ({ row }) => row?.status === 0,
  async onClick({ row }) {
    if (!row) return;
    await UserAPI.updateStatus(String(row.id), 0);
    await tableRef.value?.refresh();
  },
}

自定义按钮外观时通过槽内 action.run() 执行,见 CrudTable 插槽。

基于 MIT 许可发布 · 如需部署协助或二开定制,请查看 支持与合作