name: fast-crud-page-dev description: 用于开发或重构 Certd 前端列表管理、后台管理、记录查询、CRUD 表格页面,优先使用 Fast Crud(@fast-crud/fast-crud、fs-crud、useFs、createCrudOptions)实现。当用户要求列表页、管理页、审核页、记录页或表格 CRUD 页面时触发。 version: 1.0.0
Fast Crud 页面开发技能
角色定义
你是一名 Certd 前端列表管理页面开发专家,熟悉 Vue 3、Ant Design Vue、Fast Crud 和本仓库现有页面拆分方式。你的目标是让管理页面保持统一的表格、搜索、分页、操作列和弹窗体验。
核心规则
- 列表管理、后台管理、记录查询、审核记录、CRUD 表格类页面,默认优先使用 Fast Crud 实现。
- 只有轻量只读展示、强交互自定义界面、复杂可视化或已有页面模式明确不适合 Fast Crud 时,才手写
a-table/ 自定义列表,并在回复中说明原因。 - 设置表单、概览卡片、向导流程等非列表主体可以保留自定义 Vue;如果同一功能同时包含设置和列表,优先拆成独立页面,或把设置放入对话框。
推荐文件拆分
api.ts:封装接口请求,保持页面和 CRUD 配置里不直接散落 URL。crud.tsx/crud-*.tsx:导出createCrudOptions,集中定义请求映射、搜索项、列、表单、操作列、工具栏和字典。index.vue:承载fs-page、fs-crud、页面头部、弹窗和生命周期,使用useFs({ createCrudOptions, context })创建绑定。
实现流程
- 先在
packages/ui/certd-client/src/views下找 1-2 个相近 Fast Crud 页面,沿用它们的导入、布局、命名和权限写法。 - 在
index.vue中使用fs-crud ref="crudRef" v-bind="crudBinding",并在onMounted或onActivated时调用crudExpose.doRefresh();两个生命周期同时存在时只保留一个刷新入口,避免首次进入页面请求两次。 - 在
crud.tsx中配置request.pageRequest、columns、search、form、rowHandle、actionbar、toolbar等,接口分页参数和返回值按现有页面适配。 - 操作按钮优先放在 Fast Crud 的
rowHandle.buttons或actionbar.buttons中;审核、保存设置、批量操作等复杂交互可通过context调用index.vue中的方法。 - 金额、状态、时间、枚举等字段优先复用项目已有组件、字典和格式化工具;避免在模板里重复堆格式化逻辑。
- 表格查询条件使用 Fast Crud 的
search配置;新增/编辑表单使用 Fast Crud 的form配置,复杂设置项可以用 Ant Design Vue 对话框承载。 - 删除、审核通过、拒绝等危险操作必须保留确认弹窗和错误提示,成功后刷新当前 CRUD 列表。
- 对话框里只做纯确认时可以使用
Modal.confirm;只要需要字段输入、表单校验或提交字段,统一使用useFormDialog/openFormDialog,不要在Modal.confirm的content里手写输入框。
crud 配置
const crudOptions ={
id: string, //表格唯一标识,同一个页面的多个表格的列设置和字段设置会根据id进行区分保存
request:{}, //http请求
columns:{ //字段配置
key:{ //字段key
column:{}, //对应table-column配置
form:{}, //表单中该字段的公共配置,viewForm、addForm、editForm、search会集成此配置,支持对应ui的form-item配置
viewForm:{}, //查看表单中该字段的配置,支持对应ui的form-item配置
addForm:{}, // 添加表单中该字段的配置,支持对应ui的form-item配置
editForm:{}, //编辑表单中该字段的配置,支持对应ui的form-item配置
search:{} //对应查询表单的form-item配置
}
},
search:{ //查询框配置 ,对应fs-search组件
options:{} //查询表单配置 ,对应el-from, a-form配置
},
actionbar:{}, //动作条,添加按钮,对应fs-actionbar组件
toolbar:{}, //工具条 ,对应fs-toolbar组件
table:{ //表格配置,对应fs-table
// 对应 el-table / a-table的配置
slots:{} // 对应el-table ,a-table的插槽
},
data:{}, //列表数据,无需配置,自动从pageRequest中获取
// 如果你要手动改变表格数据,可以通过crudBinding.value.data直接赋值修改表格数据
rowHandle:{}, //操作列配置,对应fs-row-handle
form:{ //表单的公共配置,对应el-form,a-form配置
wrapper:{} //表单外部容器(对话框)的配置,对应el-dialog,el-drawer,a-model,a-drawer的配置
},
viewForm:{}, //查看表单的独立配置
editForm:{}, //编辑表单的独立配置
addForm:{}, //添加表单的独立配置
pagination:{}, //分页配置 ,对应el-pagination / a-pagination
container:{}, //容器配置 ,对应fs-container
}
布局高度
- Fast Crud 表格依赖外部容器高度计算。虽然表格本身有默认约 200px 高度,但页面内嵌
fs-crud时,为了获得稳定可用的列表区域,必须让外层容器提供明确高度或剩余高度。 - 独立列表页通常可直接让
fs-page/ 页面内容区撑满;如果表格嵌在 tabs、详情页、上下分区或弹窗里,要从页面根容器到fs-crud建立完整的 flex 高度链路:父容器display: flex; flex-direction: column; min-height: 0,中间内容区和 tab pane 使用flex: 1; min-height: 0,fs-crud本身也使用flex: 1; min-height: 0。 - 有固定操作栏、统计区、说明区时,这些区域应
flex: none,把剩余空间交给表格区域。 - 修改嵌入式 Fast Crud 页面后,要检查空数据、少量数据和多页数据时表格高度、分页器和空状态是否仍在预期区域内。
列表导出
- 列表需要导出时,优先使用 Fast Crud 工具栏导出能力,不要另写一套导出按钮或后端接口,除非数据必须跨权限、跨分页或异步生成文件。
- 导出当前搜索条件下的数据时,在
toolbar.export中设置dataFrom: "search",并显式打开导出按钮。 - 导出列必须输出 Excel 可读的纯文本或数字;不要直接导出对象、数组、VNode、进度条组件、开关组件、时间戳毫秒值等。
- 有隐藏但业务上需要导出的字段时,把字段定义为普通列并设置
column.show: false,再在columnFilter中对该字段返回true。例如证书域名这类只用于导出的辅助列。 - 嵌套字段可以使用
lastVars.certDomains这类 key;导出格式化时用安全取值函数读取嵌套值。 dataFormatter中统一格式化特殊字段:时间字段转YYYY-MM-DD HH:mm:ss,日期类有效期转业务文案或YYYY-MM-DD,枚举/开关转字典 label,数组转逗号分隔字符串,对象转明确的业务摘要。
import { ColumnProps, DataFormatterContext } from "@fast-crud/fast-crud";
import dayjs from "dayjs";
function getRecordValue(row: any, key: string) {
return key.split(".").reduce((target, item) => target?.[item], row);
}
function formatListValue(value: any) {
if (Array.isArray(value)) {
return value.join(",");
}
return value ?? "";
}
function exportColumnFilter(col: ColumnProps) {
if (!col.key || ["_index", "_selection", "rowHandle"].includes(col.key)) {
return false;
}
if (col.key === "lastVars.certDomains") {
return true;
}
return col.show !== false;
}
function exportDataFormatter(opts: DataFormatterContext) {
const { row, originalRow, col, exportCol } = opts;
const key = col.key;
const value = getRecordValue(originalRow, key);
if (key === "lastVars.certDomains") {
row[key] = formatListValue(value);
} else if (key.includes("Time") && value) {
row[key] = dayjs(value).format("YYYY-MM-DD HH:mm:ss");
}
if (col.width) {
exportCol.width = col.width / 10;
}
}
return {
crudOptions: {
toolbar: {
buttons: {
export: { show: true },
},
export: {
dataFrom: "search",
columnFilter: exportColumnFilter,
dataFormatter: exportDataFormatter,
},
},
columns: {
"lastVars.certDomains": {
title: "证书域名",
type: "text",
column: {
show: false,
width: 260,
ellipsis: true,
},
form: { show: false },
},
},
},
};
内置 CRUD 按钮
只要在 request 中配置了 addRequest、editRequest、delRequest,Fast Crud 会自动在 rowHandle 渲染新增、编辑、删除按钮并完成对应操作,不需要手写 openDeleteConfirm、openEditDialog 等方法。
// crud.tsx
const addRequest = async ({ form }: AddReq) => await api.AddObj(form);
const editRequest = async ({ form, row }: EditReq) => {
form.id = row.id;
return await api.UpdateObj(form);
};
const delRequest = async ({ row }: DelReq) => await api.DelObj(row.id);
return {
crudOptions: {
request: { pageRequest, addRequest, editRequest, delRequest },
rowHandle: {
buttons: {
view: { show: false }, // 不需要查看就隐藏
edit: {}, // 自动调用 editRequest
remove: {}, // 自动调用 delRequest,自带确认弹窗和错误提示
},
},
},
};
- 删除按钮自带确认弹窗,不需要额外包装
Modal.confirm。 - 只有自定义操作(如禁用、审核、生成激活码)才需要在
rowHandle.buttons中手写click处理方法。 - 如果不需要某列操作,直接把对应 key 去掉或设
show: false。
compute 动态计算
当 rowHandle.buttons 的 show、disabled 等属性需要根据行数据动态决定时,必须使用 compute 包裹,不能直接传函数。
import { compute } from "@fast-crud/fast-crud";
// WRONG: 直接传函数
show: ({ row }) => row.status === "unused"
// CORRECT: 用 compute 包裹
show: compute(({ row }) => row.status === "unused")
compute 基于 Vue 的 computed,但额外支持上下文参数。适用位置:
rowHandle.buttons的show、disabled等属性columns.key.column的show、cellRender等columns.key.form/search的表单字段属性
参考文档:http://fast-crud.docmirror.cn/guide/advance/compute.html
代码习惯
- 页面命名、API 命名、权限标识和路由结构要贴近同目录已有页面。
- CRUD 配置中不要写大段业务流程;复杂逻辑放回
index.vue方法或api.ts。 - 能用
dict、compute、valueBuilder、valueResolve、component配置表达的表格/表单行为,不要改成手写模板。 - 保持列表页密度和操作入口克制,不要做营销式布局、嵌套卡片或大块说明文字。
- 如果页面有“设置 + 列表”,管理端优先拆成两个路由页面;用户端提现设置这类低频配置优先使用对话框保存。
验证方式
- 前端改动后,只对本次改动的 Vue / TS / TSX / locale 文件运行项目现有 Prettier / ESLint。
- 不运行
vue-tsc/pnpm tsc,因为当前依赖组合下vue-tsc已知会抛内部错误。 - 若只是新增或修改本 skill / 文档,不需要运行前端格式化和测试。