DerivedFormState

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

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

Extended by

• FormState

Type Parameters

TFormData

TFormData

TOnMount

TOnMount extends undefined | FormValidateOrFn<TFormData>

TOnChange

TOnChange extends undefined | FormValidateOrFn<TFormData>

TOnChangeAsync

TOnChangeAsync extends undefined | FormAsyncValidateOrFn<TFormData>

TOnBlur

TOnBlur extends undefined | FormValidateOrFn<TFormData>

TOnBlurAsync

TOnBlurAsync extends undefined | FormAsyncValidateOrFn<TFormData>

TOnSubmit

TOnSubmit extends undefined | FormValidateOrFn<TFormData>

TOnSubmitAsync

TOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFormData>

TOnDynamic

TOnDynamic extends undefined | FormValidateOrFn<TFormData>

TOnDynamicAsync

TOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TFormData>

TOnServer

TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>

Properties

canSubmit

canSubmit: boolean;

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

A boolean indicating if the form can be submitted based on its current state.

errors

errors: NonNullable<
  | UnwrapFormValidateOrFn<TOnMount>
  | UnwrapFormValidateOrFn<TOnChange>
  | UnwrapFormAsyncValidateOrFn<TOnChangeAsync>
  | UnwrapFormValidateOrFn<TOnBlur>
  | UnwrapFormAsyncValidateOrFn<TOnBlurAsync>
  | UnwrapFormValidateOrFn<TOnSubmit>
  | UnwrapFormAsyncValidateOrFn<TOnSubmitAsync>
  | UnwrapFormValidateOrFn<TOnDynamic>
  | UnwrapFormAsyncValidateOrFn<TOnDynamicAsync>
  | UnwrapFormAsyncValidateOrFn<TOnServer>>[];

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

The error array for the form itself.

fieldMeta

fieldMeta: Partial<Record<DeepKeys<TFormData>, AnyFieldLikeMeta>>;

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

A record of field metadata for each field in the form.

isBlurred

isBlurred: boolean;

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

A boolean indicating if any of the form fields have been blurred.

isDefaultValue

isDefaultValue: boolean;

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

A boolean indicating if all of the form's fields are the same as default values.

isDirty

isDirty: boolean;

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

A boolean indicating if any of the form's fields' values have been modified by the user. Evaluates true if the user have modified at least one of the fields. Opposite of isPristine.

isFieldsValid

isFieldsValid: boolean;

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

A boolean indicating if all the form fields are valid. Evaluates true if there are no field errors.

isFieldsValidating

isFieldsValidating: boolean;

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

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

isFormValid

isFormValid: boolean;

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

A boolean indicating if the form is valid.

isFormValidating

isFormValidating: boolean;

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

A boolean indicating if the form is currently validating.

isPristine

isPristine: boolean;

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

A boolean indicating if none of the form's fields' values have been modified by the user. Evaluates true if the user have not modified any of the fields. Opposite of isDirty.

isTouched

isTouched: boolean;

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

A boolean indicating if any of the form fields have been touched.

isValid

isValid: boolean;

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

A boolean indicating if the form and all its fields are valid. Evaluates true if there are no errors.