Skip to content

useForm

概述

useForm 是一个基于 TanStack Query (Vue Query) 和 Ant Design Vue 的自定义 Hook,用于处理创建与编辑表单。它提供了一个完整的表单管理解决方案,包括数据获取、表单验证、提交处理和路由导航。

API 参考

参数类型必填默认值描述
keystring-唯一标识符,用于缓存管理
getApiFn(id: number) => Promise<T>-获取详情的 API 函数
createApiFn(data: any) => Promise<T>-创建数据的 API 函数
updateApiFn(id: number, data: Partial<T>) => Promise<T>-更新数据的 API 函数
formRecord<string, any>-表单初始值对象
rulesFormProps['rules'] | Ref<FormProps['rules']>{}表单验证规则
backAfterSuccessbooleantrue操作成功后是否返回上一页

返回值

属性/方法类型描述
idstring当前操作的数据 ID
titleComputedRef<string>基于操作模式的标题文本(创建/编辑)
isCreateModeboolean是否为创建模式
isEditModeboolean是否为编辑模式
formRefRef表单引用,可用于表单方法调用
formStateRef<Record<string, any>>表单状态数据
formRulesRef<FormProps['rules']> | ComputedRef<FormProps['rules']>表单验证规则
formPropsComputedRef<Object>表单属性,可直接绑定到表单组件
detailDataRef<T | undefined>详情数据
isLoadingboolean是否正在加载或提交
handleSubmit() => Promise<void>提交表单
handleBack() => void返回上一页