Type Alias: DerivedFormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer>

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

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

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

Type Parameters

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

Type declaration

canSubmit

canSubmit: boolean;

canSubmit: boolean;

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

errors

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

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

The error array for the form itself.

fieldMeta

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

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

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

isBlurred

isBlurred: boolean;

isBlurred: boolean;

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

isDefaultValue

isDefaultValue: boolean;

isDefaultValue: boolean;

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

isDirty

isDirty: boolean;

isDirty: boolean;

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;

isFieldsValid: boolean;

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

isFieldsValidating

isFieldsValidating: boolean;

isFieldsValidating: boolean;

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

isFormValid

isFormValid: boolean;

isFormValid: boolean;

A boolean indicating if the form is valid.

isFormValidating

isFormValidating: boolean;

isFormValidating: boolean;

A boolean indicating if the form is currently validating.

isPristine

isPristine: boolean;

isPristine: boolean;

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.