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

An object representing the options for a form.

• TFormData

• TFormValidator extends Validator<TFormData, unknown> | undefined = undefined

optional asyncAlways: boolean;

optional asyncAlways: boolean;

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

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

optional asyncDebounceMs: number;

optional asyncDebounceMs: number;

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

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

optional defaultState: Partial<FormState<TFormData>>;

optional defaultState: Partial<FormState<TFormData>>;

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

The default state for the form.

optional defaultValues: TFormData;

optional defaultValues: TFormData;

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

Set initial values for your form.

optional onSubmit: (props) => any;

optional onSubmit: (props) => any;

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

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>

FormApi<TFormData, TFormValidator>

TFormData

any

optional onSubmitInvalid: (props) => void;

optional onSubmitInvalid: (props) => void;

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

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

FormApi<TFormData, TFormValidator>

TFormData

void

optional transform: FormTransform<TFormData, TFormValidator>;

optional transform: FormTransform<TFormData, TFormValidator>;

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

optional validatorAdapter: TFormValidator;

optional validatorAdapter: TFormValidator;

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

A validator adapter to support usage of extra validation types (IE: Zod, Yup, or Valibot usage)

optional validators: FormValidators<TFormData, TFormValidator>;

optional validators: FormValidators<TFormData, TFormValidator>;

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

A list of validators to pass to the form