Interface: FormOptions<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>

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

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

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

The default state for the form.

defaultValues?

optional defaultValues: TFormData;

optional defaultValues: TFormData;

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

Set initial values for your form.

Inherited from

BaseFormOptions.defaultValues

formId?

optional formId: string;

optional formId: string;

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

The form name, used for devtools and identification

listeners?

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

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

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

form level listeners

onSubmit()?

optional onSubmit: (props) => any;

optional onSubmit: (props) => any;

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

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>

Parameters

props

formApi

FormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>

value

TFormData

Returns

any

onSubmitInvalid()?

optional onSubmitInvalid: (props) => void;

optional onSubmitInvalid: (props) => void;

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

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

optional onSubmitMeta: TSubmitMeta;

optional onSubmitMeta: TSubmitMeta;

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

onSubmitMeta, the data passed from the handleSubmit handler, to the onSubmit function props

Inherited from

BaseFormOptions.onSubmitMeta

transform?

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

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

validationLogic?

optional validationLogic: ValidationLogicFn;

optional validationLogic: ValidationLogicFn;

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

validators?

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

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

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

A list of validators to pass to the form