BaseFormState

类型别名:BaseFormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer>

ts
type BaseFormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer> = object;
type BaseFormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer> = object;

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

一个表示表单当前状态的对象。

类型参数

TFormData

TOnMount 扩展 undefined | FormValidateOrFn<TFormData>

TOnChange 扩展 undefined | FormValidateOrFn<TFormData>

TOnChangeAsync 扩展 undefined | FormAsyncValidateOrFn<TFormData>

TOnBlur 扩展 undefined | FormValidateOrFn<TFormData>

TOnBlurAsync 扩展 undefined | FormAsyncValidateOrFn<TFormData>

TOnSubmit 扩展 undefined | FormValidateOrFn<TFormData>

TOnSubmitAsync 扩展 undefined | FormAsyncValidateOrFn<TFormData>

TOnDynamic 扩展 undefined | FormValidateOrFn<TFormData>

TOnDynamicAsync 扩展 undefined | FormAsyncValidateOrFn<TFormData>

TOnServer 扩展 undefined | FormAsyncValidateOrFn<TFormData>

类型声明

_force_re_eval?

ts
optional _force_re_eval: boolean;
optional _force_re_eval: boolean;

@private,用于在选项更改时强制重新评估表单状态

errorMap

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

表单本身的错误映射。

fieldMetaBase

ts
fieldMetaBase: Record<DeepKeys<TFormData>, AnyFieldMetaBase>;
fieldMetaBase: Record<DeepKeys<TFormData>, AnyFieldMetaBase>;

表单中每个字段的元数据记录,不包括派生属性,如 errors

isSubmitSuccessful

ts
isSubmitSuccessful: boolean;
isSubmitSuccessful: boolean;

一个布尔值,表示上次提交是否成功。

isSubmitted

ts
isSubmitted: boolean;
isSubmitted: boolean;

一个布尔值,表示 onSubmit 函数是否已成功完成。

在每次新的提交尝试时会重置为 false

注意:您可以使用 isSubmitting 来检查表单当前是否正在提交。

isSubmitting

ts
isSubmitting: boolean;
isSubmitting: boolean;

一个布尔值,表示在调用 handleSubmit 后,表单当前是否处于提交过程中。

当因以下任一原因完成提交时,会重置为 false

  • 验证步骤返回了错误。
  • onSubmit 函数已完成。

注意:如果您在 onSubmit 函数中运行异步操作,请确保 await 它们,以确保 isSubmitting 仅在异步操作完成后才设置为 false

这对于在提交期间显示加载指示器或禁用表单输入非常有用。

isValidating

ts
isValidating: boolean;
isValidating: boolean;

一个布尔值,表示表单或其任何字段当前是否正在验证。

submissionAttempts

ts
submissionAttempts: number;
submissionAttempts: number;

一个用于跟踪提交尝试次数的计数器。

validationMetaMap

ts
validationMetaMap: Record<ValidationErrorMapKeys, ValidationMeta | undefined>;
validationMetaMap: Record<ValidationErrorMapKeys, ValidationMeta | undefined>;

一个内部机制,用于跟踪表单中的验证逻辑。

values

ts
values: TFormData;
values: TFormData;

表单字段的当前值。

我们的合作伙伴
Code Rabbit
订阅 Bytes

您的每周 JavaScript 资讯。每周一免费发送给超过 10 万开发者。

Bytes

无垃圾邮件。您可以随时取消订阅。

订阅 Bytes

您的每周 JavaScript 资讯。每周一免费发送给超过 10 万开发者。

Bytes

无垃圾邮件。您可以随时取消订阅。