TanStackForm v1
自动
框架
版本
菜单
入门
指南
API 参考
社区资源
示例

FormState

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

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

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

扩展
  • BaseFormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer>.DerivedFormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer>

类型参数

• 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>

属性

_force_re_eval?
ts
optional _force_re_eval: boolean;

optional _force_re_eval: boolean;

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

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

继承自
ts
BaseFormState._force_re_eval

BaseFormState._force_re_eval

canSubmit
ts
canSubmit: boolean;

canSubmit: boolean;

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

一个布尔值，指示表单是否可以根据其当前状态提交。

继承自
ts
DerivedFormState.canSubmit

DerivedFormState.canSubmit

errorMap
ts
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>>;

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

表单本身的错误映射。

继承自
ts
BaseFormState.errorMap

BaseFormState.errorMap

errors
ts
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>)[];

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

表单本身的错误数组。

继承自
ts
DerivedFormState.errors

DerivedFormState.errors

fieldMeta
ts
fieldMeta: Record<DeepKeys<TFormData>, AnyFieldMeta>;

fieldMeta: Record<DeepKeys<TFormData>, AnyFieldMeta>;

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

表单中每个字段的字段元数据记录。

继承自
ts
DerivedFormState.fieldMeta

DerivedFormState.fieldMeta

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

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

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

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

继承自
ts
BaseFormState.fieldMetaBase

BaseFormState.fieldMetaBase

isBlurred
ts
isBlurred: boolean;

isBlurred: boolean;

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

一个布尔值，指示表单字段是否已失焦。

继承自
ts
DerivedFormState.isBlurred

DerivedFormState.isBlurred

isDefaultValue
ts
isDefaultValue: boolean;

isDefaultValue: boolean;

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

一个布尔值，指示表单的所有字段是否与其默认值相同。

继承自
ts
DerivedFormState.isDefaultValue

DerivedFormState.isDefaultValue

isDirty
ts
isDirty: boolean;

isDirty: boolean;

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

一个布尔值，指示用户是否已修改表单字段的值。如果用户至少修改了一个字段，则计算结果为 true。与 isPristine 相反。

继承自
ts
DerivedFormState.isDirty

DerivedFormState.isDirty

isFieldsValid
ts
isFieldsValid: boolean;

isFieldsValid: boolean;

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

一个布尔值，指示所有表单字段是否有效。如果没有字段错误，则计算结果为 true。

继承自
ts
DerivedFormState.isFieldsValid

DerivedFormState.isFieldsValid

isFieldsValidating
ts
isFieldsValidating: boolean;

isFieldsValidating: boolean;

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

一个布尔值，指示表单字段当前是否正在校验。

继承自
ts
DerivedFormState.isFieldsValidating

DerivedFormState.isFieldsValidating

isFormValid
ts
isFormValid: boolean;

isFormValid: boolean;

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

一个布尔值，指示表单是否有效。

继承自
ts
DerivedFormState.isFormValid

DerivedFormState.isFormValid

isFormValidating
ts
isFormValidating: boolean;

isFormValidating: boolean;

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

一个布尔值，指示表单当前是否正在校验。

继承自
ts
DerivedFormState.isFormValidating

DerivedFormState.isFormValidating

isPristine
ts
isPristine: boolean;

isPristine: boolean;

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

一个布尔值，指示用户是否未修改表单字段的值。如果用户未修改任何字段，则计算结果为 true。与 isDirty 相反。

继承自
ts
DerivedFormState.isPristine

DerivedFormState.isPristine

isSubmitSuccessful
ts
isSubmitSuccessful: boolean;

isSubmitSuccessful: boolean;

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

一个布尔值，指示上次提交是否成功。

继承自
ts
BaseFormState.isSubmitSuccessful

BaseFormState.isSubmitSuccessful

isSubmitted
ts
isSubmitted: boolean;

isSubmitted: boolean;

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

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

在每次新的提交尝试时返回 false。

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

继承自
ts
BaseFormState.isSubmitted

BaseFormState.isSubmitted

isSubmitting
ts
isSubmitting: boolean;

isSubmitting: boolean;

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

一个布尔值，指示在调用 handleSubmit 后表单当前是否正在提交过程中。

当提交因以下原因之一完成时返回 false：

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

注意：如果您在 onSubmit 函数中运行异步操作，请确保等待它们以确保仅在异步操作完成时将 isSubmitting 设置为 false。

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

继承自
ts
BaseFormState.isSubmitting

BaseFormState.isSubmitting

isTouched
ts
isTouched: boolean;

isTouched: boolean;

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

一个布尔值，指示表单字段是否已被触摸。

继承自
ts
DerivedFormState.isTouched

DerivedFormState.isTouched

isValid
ts
isValid: boolean;

isValid: boolean;

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

一个布尔值，指示表单及其所有字段是否有效。如果没有错误，则计算结果为 true。

继承自
ts
DerivedFormState.isValid

DerivedFormState.isValid

isValidating
ts
isValidating: boolean;

isValidating: boolean;

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

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

继承自
ts
BaseFormState.isValidating

BaseFormState.isValidating

submissionAttempts
ts
submissionAttempts: number;

submissionAttempts: number;

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

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

继承自
ts
BaseFormState.submissionAttempts

BaseFormState.submissionAttempts

validationMetaMap
ts
validationMetaMap: Record<"onChange" | "onBlur" | "onSubmit" | "onMount" | "onServer", undefined | ValidationMeta>;

validationMetaMap: Record<"onChange" | "onBlur" | "onSubmit" | "onMount" | "onServer", undefined | ValidationMeta>;

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

用于跟踪表单中校验逻辑的内部机制。

继承自
ts
BaseFormState.validationMetaMap

BaseFormState.validationMetaMap

values
ts
values: TFormData;

values: TFormData;

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

表单字段的当前值。

继承自
ts
BaseFormState.values

BaseFormState.values
在 GitHub 上编辑
首页