类: FormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer, TSubmitMeta>

定义于: packages/form-core/src/FormApi.ts:772

表示表单 API 的类。它处理逻辑和与表单状态的交互。

通常，您不需要直接创建新的 FormApi 实例。相反，您将使用框架钩子/函数（如 useForm 或 createForm）为您创建一个使用框架响应式模型的新实例。但是，如果您需要手动创建新实例，可以通过调用 new FormApi 构造函数来实现。

类型参数

• TFormData

• TOnMount extends undefined | FormValidateOrFn<TFormData>

• TOnChange extends undefined | FormValidateOrFn<TFormData>

• TOnChangeAsync extends undefined | FormAsyncValidateOrFn<TFormData>

• TOnBlur extends undefined | FormValidateOrFn<TFormData>

• TOnBlurAsync extends undefined | FormAsyncValidateOrFn<TFormData>

• TOnSubmit extends undefined | FormValidateOrFn<TFormData>

• TOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFormData>

• TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>

• TSubmitMeta = never

构造函数

new FormApi()

new FormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer, TSubmitMeta>(opts?): FormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer, TSubmitMeta>

new FormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer, TSubmitMeta>(opts?): FormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer, TSubmitMeta>

定义于: packages/form-core/src/FormApi.ts:843

使用给定的表单选项构造一个新的 FormApi 实例。

参数

opts?

FormOptions<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer, TSubmitMeta>

FormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer, TSubmitMeta>

属性

baseStore

baseStore: Store<BaseFormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer>>;

baseStore: Store<BaseFormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer>>;

定义于: packages/form-core/src/FormApi.ts:799

fieldInfo

fieldInfo: Record<DeepKeys<TFormData>, FieldInfo<TFormData>>;

fieldInfo: Record<DeepKeys<TFormData>, FieldInfo<TFormData>>;

定义于: packages/form-core/src/FormApi.ts:829

表单中每个字段的字段信息记录。

fieldMetaDerived

fieldMetaDerived: Derived<Record<DeepKeys<TFormData>, AnyFieldMeta>>;

fieldMetaDerived: Derived<Record<DeepKeys<TFormData>, AnyFieldMeta>>;

定义于: packages/form-core/src/FormApi.ts:812

options

options: FormOptions<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer, TSubmitMeta> = {};

options: FormOptions<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer, TSubmitMeta> = {};

定义于: packages/form-core/src/FormApi.ts:787

表单选项。

store

store: Derived<FormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer>>;

store: Derived<FormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer>>;

定义于: packages/form-core/src/FormApi.ts:813

访问器

state

Get 签名

get state(): FormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer>

get state(): FormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer>

定义于: packages/form-core/src/FormApi.ts:831

FormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer>

方法

clearFieldValues()

clearFieldValues<TField>(field, opts?): void

clearFieldValues<TField>(field, opts?): void

定义于: packages/form-core/src/FormApi.ts:2133

清除数组字段中的所有值。

deleteField<TField>(field): void

deleteField<TField>(field): void

定义于: packages/form-core/src/FormApi.ts:1941

getAllErrors(): object

getAllErrors(): object

定义于: packages/form-core/src/FormApi.ts:2239

返回表单和字段级别的错误。

object

fields

fields: Record<DeepKeys<TFormData>, {
  errorMap: ValidationErrorMap;
  errors: unknown[];
}>;

fields: Record<DeepKeys<TFormData>, {
  errorMap: ValidationErrorMap;
  errors: unknown[];
}>;

form

form: object;

form: object;

form.errorMap

errorMap: ValidationErrorMap<UnwrapFormValidateOrFn<TOnMount>, UnwrapFormValidateOrFn<TOnChange>, UnwrapFormAsyncValidateOrFn<TOnChangeAsync>, UnwrapFormValidateOrFn<TOnBlur>, UnwrapFormAsyncValidateOrFn<TOnBlurAsync>, UnwrapFormValidateOrFn<TOnSubmit>, UnwrapFormAsyncValidateOrFn<TOnSubmitAsync>, UnwrapFormAsyncValidateOrFn<TOnServer>>;

errorMap: ValidationErrorMap<UnwrapFormValidateOrFn<TOnMount>, UnwrapFormValidateOrFn<TOnChange>, UnwrapFormAsyncValidateOrFn<TOnChangeAsync>, UnwrapFormValidateOrFn<TOnBlur>, UnwrapFormAsyncValidateOrFn<TOnBlurAsync>, UnwrapFormValidateOrFn<TOnSubmit>, UnwrapFormAsyncValidateOrFn<TOnSubmitAsync>, UnwrapFormAsyncValidateOrFn<TOnServer>>;

form.errors

errors: (
  | UnwrapFormValidateOrFn<TOnMount>
  | UnwrapFormValidateOrFn<TOnChange>
  | UnwrapFormAsyncValidateOrFn<TOnChangeAsync>
  | UnwrapFormValidateOrFn<TOnBlur>
  | UnwrapFormAsyncValidateOrFn<TOnBlurAsync>
  | UnwrapFormValidateOrFn<TOnSubmit>
  | UnwrapFormAsyncValidateOrFn<TOnSubmitAsync>
  | UnwrapFormAsyncValidateOrFn<TOnServer>)[];

errors: (
  | UnwrapFormValidateOrFn<TOnMount>
  | UnwrapFormValidateOrFn<TOnChange>
  | UnwrapFormAsyncValidateOrFn<TOnChangeAsync>
  | UnwrapFormValidateOrFn<TOnBlur>
  | UnwrapFormAsyncValidateOrFn<TOnBlurAsync>
  | UnwrapFormValidateOrFn<TOnSubmit>
  | UnwrapFormAsyncValidateOrFn<TOnSubmitAsync>
  | UnwrapFormAsyncValidateOrFn<TOnServer>)[];

getFieldInfo()

getFieldInfo<TField>(field): FieldInfo<TFormData>

getFieldInfo<TField>(field): FieldInfo<TFormData>

定义于: packages/form-core/src/FormApi.ts:1855

获取指定字段的字段信息。

getFieldMeta<TField>(field): undefined | AnyFieldMeta

getFieldMeta<TField>(field): undefined | AnyFieldMeta

定义于: packages/form-core/src/FormApi.ts:1846

获取指定字段的元数据。

getFieldValue<TField>(field): DeepValue<TFormData, TField>

getFieldValue<TField>(field): DeepValue<TFormData, TField>

定义于: packages/form-core/src/FormApi.ts:1839

获取指定字段的值。

handleSubmit(): Promise<void>

handleSubmit(): Promise<void>

定义于: packages/form-core/src/FormApi.ts:1741

处理表单提交，执行校验，并调用相应的 onSubmit 或 onSubmitInvalid 回调。

Promise<void>

调用签名

handleSubmit(submitMeta): Promise<void>

handleSubmit(submitMeta): Promise<void>

定义于: packages/form-core/src/FormApi.ts:1742

处理表单提交，执行校验，并调用相应的 onSubmit 或 onSubmitInvalid 回调。

insertFieldValue<TField>(
   field,
   index,
   value,
opts?): Promise<void>

insertFieldValue<TField>(
   field,
   index,
   value,
opts?): Promise<void>

定义于: packages/form-core/src/FormApi.ts:1980

mount(): () => void

mount(): () => void

定义于: packages/form-core/src/FormApi.ts:1169

Function

void

moveFieldValues()

moveFieldValues<TField>(
   field,
   index1,
   index2,
   opts?): void

moveFieldValues<TField>(
   field,
   index1,
   index2,
   opts?): void

定义于: packages/form-core/src/FormApi.ts:2104

将数组字段中第一个指定索引处的值移动到第二个指定索引处。

parseValuesWithSchema(schema):
  | undefined
  | {
  fields: Record<string, StandardSchemaV1Issue[]>;
  form: Record<string, StandardSchemaV1Issue[]>;
}

parseValuesWithSchema(schema):
  | undefined
  | {
  fields: Record<string, StandardSchemaV1Issue[]>;
  form: Record<string, StandardSchemaV1Issue[]>;
}

定义于: packages/form-core/src/FormApi.ts:2299

使用给定的标准模式解析表单的值并返回问题（如果有）。此方法不会设置任何内部错误。

参数

schema

StandardSchemaV1<TFormData, unknown>

用于解析表单值的标准模式。

| undefined | { fields: Record<string, StandardSchemaV1Issue[]>; form: Record<string, StandardSchemaV1Issue[]>; }

parseValuesWithSchemaAsync()

parseValuesWithSchemaAsync(schema): Promise<
  | undefined
  | {
  fields: Record<string, StandardSchemaV1Issue[]>;
  form: Record<string, StandardSchemaV1Issue[]>;
}>

parseValuesWithSchemaAsync(schema): Promise<
  | undefined
  | {
  fields: Record<string, StandardSchemaV1Issue[]>;
  form: Record<string, StandardSchemaV1Issue[]>;
}>

定义于: packages/form-core/src/FormApi.ts:2311

使用给定的标准模式异步解析表单的值并返回问题（如果有）。此方法不会设置任何内部错误。

参数

schema

StandardSchemaV1<TFormData, unknown>

用于解析表单值的标准模式。

Promise< | undefined | { fields: Record<string, StandardSchemaV1Issue[]>; form: Record<string, StandardSchemaV1Issue[]>; }>

pushFieldValue()

pushFieldValue<TField>(
   field,
   value,
   opts?): void

pushFieldValue<TField>(
   field,
   value,
   opts?): void

定义于: packages/form-core/src/FormApi.ts:1965

将值推入数组字段。

removeFieldValue<TField>(
   field,
   index,
opts?): Promise<void>

removeFieldValue<TField>(
   field,
   index,
opts?): Promise<void>

定义于: packages/form-core/src/FormApi.ts:2038

从数组字段中删除指定索引处的值。

replaceFieldValue<TField>(
   field,
   index,
   value,
opts?): Promise<void>

replaceFieldValue<TField>(
   field,
   index,
   value,
opts?): Promise<void>

定义于: packages/form-core/src/FormApi.ts:2012

将值替换到数组字段的指定索引处。

reset(values?, opts?): void

reset(values?, opts?): void

定义于: packages/form-core/src/FormApi.ts:1257

将表单状态重置为默认值。如果提供了值，表单将重置为这些值，并且默认值将被更新。

resetField<TField>(field): void

resetField<TField>(field): void

定义于: packages/form-core/src/FormApi.ts:2159

将字段值和元数据重置为默认状态。

resetFieldMeta<TField>(fieldMeta): Record<TField, AnyFieldMeta>

resetFieldMeta<TField>(fieldMeta): Record<TField, AnyFieldMeta>

定义于: packages/form-core/src/FormApi.ts:1895

重置每个字段的元数据。

setErrorMap(errorMap): void

setErrorMap(errorMap): void

定义于: packages/form-core/src/FormApi.ts:2177

更新表单的 errorMap。

参数

errorMap

FormValidationErrorMap<TFormData, UnwrapFormValidateOrFn<TOnMount>, UnwrapFormValidateOrFn<TOnChange>, UnwrapFormAsyncValidateOrFn<TOnChangeAsync>, UnwrapFormValidateOrFn<TOnBlur>, UnwrapFormAsyncValidateOrFn<TOnBlurAsync>, UnwrapFormValidateOrFn<TOnSubmit>, UnwrapFormAsyncValidateOrFn<TOnSubmitAsync>, UnwrapFormAsyncValidateOrFn<TOnServer>>

void

setFieldMeta()

setFieldMeta<TField>(field, updater): void

setFieldMeta<TField>(field, updater): void

定义于: packages/form-core/src/FormApi.ts:1874

更新指定字段的元数据。

setFieldValue<TField>(
   field,
   updater,
   opts?): void

setFieldValue<TField>(
   field,
   updater,
   opts?): void

定义于: packages/form-core/src/FormApi.ts:1911

设置指定字段的值，并可选择更新触摸状态。

swapFieldValues<TField>(
   field,
   index1,
   index2,
   opts?): void

swapFieldValues<TField>(
   field,
   index1,
   index2,
   opts?): void

定义于: packages/form-core/src/FormApi.ts:2075

交换数组字段中指定索引处的值。

update(options?): void

update(options?): void

定义于: packages/form-core/src/FormApi.ts:1189

更新表单选项和表单状态。

validateAllFields(cause): Promise<unknown[]>

validateAllFields(cause): Promise<unknown[]>

定义于: packages/form-core/src/FormApi.ts:1283

使用给定校验原因的正确处理程序校验所有字段。

validateArrayFieldsStartingFrom<TField>(
   field,
   index,
cause): Promise<unknown[]>

validateArrayFieldsStartingFrom<TField>(
   field,
   index,
cause): Promise<unknown[]>

定义于: packages/form-core/src/FormApi.ts:1313

使用给定校验类型的正确处理程序，从给定索引开始到结束，校验表单中指定数组的子项。

validateField<TField>(field, cause): unknown[] | Promise<unknown[]>

validateField<TField>(field, cause): unknown[] | Promise<unknown[]>

定义于: packages/form-core/src/FormApi.ts:1354

使用给定校验类型的正确处理程序校验表单中的指定字段。

FormApi

类: FormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer, TSubmitMeta>

类型参数

构造函数

new FormApi()

参数

opts?

返回

属性

baseStore

fieldInfo

fieldMetaDerived

options

store

访问器

state

Get 签名

返回

方法

clearFieldValues()

类型参数

参数

field

opts?

返回

deleteField()

类型参数

参数

field

返回

getAllErrors()

返回

fields

form

form.errorMap

form.errors

getFieldInfo()

类型参数

参数

field

返回

getFieldMeta()

类型参数

参数

field

返回

getFieldValue()

类型参数

参数

field

返回

handleSubmit()

调用签名

返回

调用签名

参数

submitMeta

返回

insertFieldValue()

类型参数

参数

field

index

value

opts?

返回

mount()

返回

返回

moveFieldValues()

类型参数

参数

field

index1

index2

opts?

返回

parseValuesWithSchema()

参数

schema