Defined in: packages/form-core/src/FormApi.ts:545
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>
• TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>
optional _force_re_eval: boolean;
optional _force_re_eval: boolean;
Defined in: packages/form-core/src/FormApi.ts:472
@private, used to force a re-evaluation of the form state when options change
BaseFormState._force_re_eval
BaseFormState._force_re_eval
canSubmit: boolean;
canSubmit: boolean;
Defined in: packages/form-core/src/FormApi.ts:538
A boolean indicating if the form can be submitted based on its current state.
DerivedFormState.canSubmit
DerivedFormState.canSubmit
errorMap: FormValidationErrorMap<UnwrapFormValidateOrFn<TOnMount>, UnwrapFormValidateOrFn<TOnChange>, UnwrapFormAsyncValidateOrFn<TOnChangeAsync>, UnwrapFormValidateOrFn<TOnBlur>, UnwrapFormAsyncValidateOrFn<TOnBlurAsync>, UnwrapFormValidateOrFn<TOnSubmit>, UnwrapFormAsyncValidateOrFn<TOnSubmitAsync>, UnwrapFormAsyncValidateOrFn<TOnServer>>;
errorMap: FormValidationErrorMap<UnwrapFormValidateOrFn<TOnMount>, UnwrapFormValidateOrFn<TOnChange>, UnwrapFormAsyncValidateOrFn<TOnChangeAsync>, UnwrapFormValidateOrFn<TOnBlur>, UnwrapFormAsyncValidateOrFn<TOnBlurAsync>, UnwrapFormValidateOrFn<TOnSubmit>, UnwrapFormAsyncValidateOrFn<TOnSubmitAsync>, UnwrapFormAsyncValidateOrFn<TOnServer>>;
Defined in: packages/form-core/src/FormApi.ts:418
The error map for the form itself.
BaseFormState.errorMap
BaseFormState.errorMap
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>)[];
Defined in: packages/form-core/src/FormApi.ts:497
The error array for the form itself.
DerivedFormState.errors
DerivedFormState.errors
fieldMeta: Record<DeepKeys<TFormData>, AnyFieldMeta>;
fieldMeta: Record<DeepKeys<TFormData>, AnyFieldMeta>;
Defined in: packages/form-core/src/FormApi.ts:542
A record of field metadata for each field in the form.
DerivedFormState.fieldMeta
DerivedFormState.fieldMeta
fieldMetaBase: Record<DeepKeys<TFormData>, AnyFieldMetaBase>;
fieldMetaBase: Record<DeepKeys<TFormData>, AnyFieldMetaBase>;
Defined in: packages/form-core/src/FormApi.ts:435
A record of field metadata for each field in the form, not including the derived properties, like errors and such
BaseFormState.fieldMetaBase
BaseFormState.fieldMetaBase
isBlurred: boolean;
isBlurred: boolean;
Defined in: packages/form-core/src/FormApi.ts:522
A boolean indicating if any of the form fields have been blurred.
DerivedFormState.isBlurred
DerivedFormState.isBlurred
isDirty: boolean;
isDirty: boolean;
Defined in: packages/form-core/src/FormApi.ts:526
A boolean indicating if any of the form's fields' values have been modified by the user. True if the user have modified at least one of the fields. Opposite of isPristine.
DerivedFormState.isDirty
DerivedFormState.isDirty
isFieldsValid: boolean;
isFieldsValid: boolean;
Defined in: packages/form-core/src/FormApi.ts:514
A boolean indicating if all the form fields are valid.
DerivedFormState.isFieldsValid
DerivedFormState.isFieldsValid
isFieldsValidating: boolean;
isFieldsValidating: boolean;
Defined in: packages/form-core/src/FormApi.ts:510
A boolean indicating if any of the form fields are currently validating.
DerivedFormState.isFieldsValidating
DerivedFormState.isFieldsValidating
isFormValid: boolean;
isFormValid: boolean;
Defined in: packages/form-core/src/FormApi.ts:493
A boolean indicating if the form is valid.
DerivedFormState.isFormValid
DerivedFormState.isFormValid
isFormValidating: boolean;
isFormValidating: boolean;
Defined in: packages/form-core/src/FormApi.ts:489
A boolean indicating if the form is currently validating.
DerivedFormState.isFormValidating
DerivedFormState.isFormValidating
isPristine: boolean;
isPristine: boolean;
Defined in: packages/form-core/src/FormApi.ts:530
A boolean indicating if none of the form's fields' values have been modified by the user. True if the user have not modified any of the fields. Opposite of isDirty.
DerivedFormState.isPristine
DerivedFormState.isPristine
isSubmitSuccessful: boolean;
isSubmitSuccessful: boolean;
Defined in: packages/form-core/src/FormApi.ts:468
A boolean indicating if the last submission was successful.
BaseFormState.isSubmitSuccessful
BaseFormState.isSubmitSuccessful
isSubmitted: boolean;
isSubmitted: boolean;
Defined in: packages/form-core/src/FormApi.ts:456
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.
BaseFormState.isSubmitted
BaseFormState.isSubmitted
isSubmitting: boolean;
isSubmitting: boolean;
Defined in: packages/form-core/src/FormApi.ts:448
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:
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.
BaseFormState.isSubmitting
BaseFormState.isSubmitting
isTouched: boolean;
isTouched: boolean;
Defined in: packages/form-core/src/FormApi.ts:518
A boolean indicating if any of the form fields have been touched.
DerivedFormState.isTouched
DerivedFormState.isTouched
isValid: boolean;
isValid: boolean;
Defined in: packages/form-core/src/FormApi.ts:534
A boolean indicating if the form and all its fields are valid.
DerivedFormState.isValid
DerivedFormState.isValid
isValidating: boolean;
isValidating: boolean;
Defined in: packages/form-core/src/FormApi.ts:460
A boolean indicating if the form or any of its fields are currently validating.
BaseFormState.isValidating
BaseFormState.isValidating
submissionAttempts: number;
submissionAttempts: number;
Defined in: packages/form-core/src/FormApi.ts:464
A counter for tracking the number of submission attempts.
BaseFormState.submissionAttempts
BaseFormState.submissionAttempts
validationMetaMap: Record<"onChange" | "onBlur" | "onSubmit" | "onMount" | "onServer", undefined | ValidationMeta>;
validationMetaMap: Record<"onChange" | "onBlur" | "onSubmit" | "onMount" | "onServer", undefined | ValidationMeta>;
Defined in: packages/form-core/src/FormApi.ts:431
An internal mechanism used for keeping track of validation logic in a form.
BaseFormState.validationMetaMap
BaseFormState.validationMetaMap
values: TFormData;
values: TFormData;
Defined in: packages/form-core/src/FormApi.ts:414
The current values of the form fields.
BaseFormState.values
BaseFormState.values
Your weekly dose of JavaScript news. Delivered every Monday to over 100,000 devs, for free.