Interface: FormState<TFormData, TFormErrorTypes>#

Defined in: FormApi/FormApi.public.ts:214

Type Parameters#

TFormData#

TFormData

TFormErrorTypes#

TFormErrorTypes extends FormErrorTypes

Properties#

canSubmit#

canSubmit: boolean;

Defined in: FormApi/FormApi.public.ts:258

Whether the form can currently be submitted.

This is an optimistic button affordance: true until validation has found errors, then false while errors are known or the form is submitting.

errors#

errors: FormErrors<TFormErrorTypes>;

Defined in: FormApi/FormApi.public.ts:243

Array of form-level validation errors.

isDefaultValue#

isDefaultValue: boolean;

Defined in: FormApi/FormApi.public.ts:239

Whether the current form values are deeply equal to the default values.

isDirty#

isDirty: boolean;

Defined in: FormApi/FormApi.public.ts:231

Whether the form has been dirtied. The opposite of isPristine.

TODO add link to persistent dirty model? Or maybe a reference to isDefaultValue?

isInvalid#

isInvalid: boolean;

Defined in: FormApi/FormApi.public.ts:251

Whether the form currently has form-level or field-level errors.

isPristine#

isPristine: boolean;

Defined in: FormApi/FormApi.public.ts:235

Whether the form has not yet been dirtied. The opposite of isDirty.

isSubmitSuccessful#

isSubmitSuccessful: boolean;

Defined in: FormApi/FormApi.public.ts:267

Whether the latest submission completed without validation or submit errors.

isSubmitting#

isSubmitting: boolean;

Defined in: FormApi/FormApi.public.ts:263

Whether the form is currently in the process of submitting.

isTouched#

isTouched: boolean;

Defined in: FormApi/FormApi.public.ts:225

Whether the form has been touched.

isValid#

isValid: boolean;

Defined in: FormApi/FormApi.public.ts:247

Whether the form currently has no form-level or field-level errors.

isValidating#

isValidating: boolean;

Defined in: FormApi/FormApi.public.ts:271

Whether the form or any field is currently validating.

submissionAttempts#

submissionAttempts: number;

Defined in: FormApi/FormApi.public.ts:277

The number of times a submission has been attempted, regardless of its success.

If the form is reset, this will revert back to 0.

values#

values: TFormData;

Defined in: FormApi/FormApi.public.ts:221

The current values of the form.