optional asyncAlways: boolean;

If true, always run async validation, even when sync validation has produced an error. Defaults to undefined.

optional asyncDebounceMs: number;

Optional time in milliseconds if you want to introduce a delay before firing off an async action.

optional canSubmitWhenInvalid: boolean;

If true, allows the form to be submitted in an invalid state i.e. canSubmit will remain true regardless of validation errors. Defaults to undefined.

optional defaultState: Partial<FormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer>>;

The default state for the form.

optional listeners: FormListeners<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>;

form level listeners

optional onSubmit: (props) => any;

A function to be called when the form is submitted, what should happen once the user submits a valid form returns `any` or a promise `Promise<any>`

optional onSubmitInvalid: (props) => void;

Specify an action for scenarios where the user tries to submit an invalid form.

optional transform: FormTransform<NoInfer<TFormData>, NoInfer<TOnMount>, NoInfer<TOnChange>, NoInfer<TOnChangeAsync>, NoInfer<TOnBlur>, NoInfer<TOnBlurAsync>, NoInfer<TOnSubmit>, NoInfer<TOnSubmitAsync>, NoInfer<TOnDynamic>, NoInfer<TOnDynamicAsync>, NoInfer<TOnServer>, NoInfer<TSubmitMeta>>;

optional validationLogic: ValidationLogicFn;

optional validators: FormValidators<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync>;

A list of validators to pass to the form

An object representing the current state of the form.

optional _force_re_eval: boolean;

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

canSubmit: boolean;

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

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.

| UnwrapFormAsyncValidateOrFn<TOnServer>)[];

The error array for the form itself.

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

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

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

isBlurred: boolean;

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

isDefaultValue: boolean;

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

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

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

isFieldsValidating: boolean;

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

isFormValid: boolean;

A boolean indicating if the form is valid.

isFormValidating: boolean;

A boolean indicating if the form is currently validating.

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`.

isSubmitSuccessful: boolean;

A boolean indicating if the last submission was successful.

isSubmitted: boolean;

A boolean indicating if the `onSubmit` function has completed successfully.

isSubmitting: boolean;

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

isTouched: boolean;

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

isValid: boolean;

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

isValidating: boolean;

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

submissionAttempts: number;

A counter for tracking the number of submission attempts.

validationMetaMap: Record<"onMount" | "onChange" | "onBlur" | "onSubmit" | "onDynamic" | "onServer", undefined | ValidationMeta>;

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

values: TFormData;

The current values of the form fields.

type AnyFormApi = FormApi<any, any, any, any, any, any, any, any, any, any, any, any>;

A type representing the Form API with all generics set to `any` for convenience.

type AnyFormState = FormState<any, any, any, any, any, any, any, any, any, any, any>;

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

An object representing the current state of the form.

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

type FieldInfo<TFormData> = object;

An object representing the field information for a specific field within the form.

type ValidationMeta = object;

An object representing the validation metadata for a field. Not intended for public usage.