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;

Defined in: packages/form-core/src/FormApi.ts:564

An object representing the current state of the form.

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

• TOnDynamic extends undefined | FormValidateOrFn<TFormData>

• TOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TFormData>

• TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>

optional _force_re_eval: boolean;

optional _force_re_eval: boolean;

@private, used to force a re-evaluation of the form state when options change

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

The error map for the form itself.

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

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

A record of field metadata for each field in the form, not including the derived properties, like errors and such

isSubmitSuccessful: boolean;

isSubmitSuccessful: boolean;

A boolean indicating if the last submission was successful.

isSubmitted: boolean;

isSubmitted: boolean;

A boolean indicating if the onSubmit function has completed successfully.

Goes back to false at each new submission attempt.

Note: you can use isSubmitting to check if the form is currently submitting.

isSubmitting: boolean;

isSubmitting: boolean;

A boolean indicating if the form is currently in the process of being submitted after handleSubmit is called.

Goes back to false when submission completes for one of the following reasons:

• the validation step returned errors.
• the onSubmit function has completed.

Note: if you're running async operations in your onSubmit function make sure to await them to ensure isSubmitting is set to false only when the async operation completes.

This is useful for displaying loading indicators or disabling form inputs during submission.

isValidating: boolean;

isValidating: boolean;

A boolean indicating if the form or any of its fields are currently validating.

submissionAttempts: number;

submissionAttempts: number;

A counter for tracking the number of submission attempts.

validationMetaMap: Record<ValidationErrorMapKeys, ValidationMeta | undefined>;

validationMetaMap: Record<ValidationErrorMapKeys, ValidationMeta | undefined>;

An internal mechanism used for keeping track of validation logic in a form.

values: TFormData;

values: TFormData;

The current values of the form fields.