--- id: FormOptions title: FormOptions --- # Interface: FormOptions\ Defined in: [packages/form-core/src/FormApi.ts:450](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L450) An object representing the options for a form. ## Extends - [`BaseFormOptions`](BaseFormOptions.md)\<`TFormData`, `TSubmitMeta`\> ## 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`\> ### TSubmitMeta `TSubmitMeta` = `never` ## Properties ### asyncAlways? ```ts optional asyncAlways: boolean; ``` Defined in: [packages/form-core/src/FormApi.ts:489](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L489) If true, always run async validation, even when sync validation has produced an error. Defaults to undefined. *** ### asyncDebounceMs? ```ts optional asyncDebounceMs: number; ``` Defined in: [packages/form-core/src/FormApi.ts:493](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L493) Optional time in milliseconds if you want to introduce a delay before firing off an async action. *** ### canSubmitWhenInvalid? ```ts optional canSubmitWhenInvalid: boolean; ``` Defined in: [packages/form-core/src/FormApi.ts:497](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L497) 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. *** ### defaultState? ```ts optional defaultState: Partial>; ``` Defined in: [packages/form-core/src/FormApi.ts:471](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L471) The default state for the form. *** ### defaultValues? ```ts optional defaultValues: TFormData; ``` Defined in: [packages/form-core/src/FormApi.ts:440](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L440) Set initial values for your form. #### Inherited from [`BaseFormOptions`](BaseFormOptions.md).[`defaultValues`](BaseFormOptions.md#defaultvalues) *** ### formId? ```ts optional formId: string; ``` Defined in: [packages/form-core/src/FormApi.ts:467](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L467) The form name, used for devtools and identification *** ### listeners? ```ts optional listeners: FormListeners; ``` Defined in: [packages/form-core/src/FormApi.ts:519](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L519) form level listeners *** ### onSubmit()? ```ts optional onSubmit: (props) => any; ``` Defined in: [packages/form-core/src/FormApi.ts:537](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L537) 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` #### Parameters ##### props ###### formApi [`FormApi`](../classes/FormApi.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`\> ###### meta `TSubmitMeta` ###### value `TFormData` #### Returns `any` *** ### onSubmitInvalid()? ```ts optional onSubmitInvalid: (props) => void; ``` Defined in: [packages/form-core/src/FormApi.ts:558](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L558) Specify an action for scenarios where the user tries to submit an invalid form. #### Parameters ##### props ###### formApi [`FormApi`](../classes/FormApi.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`\> ###### meta `TSubmitMeta` ###### value `TFormData` #### Returns `void` *** ### onSubmitMeta? ```ts optional onSubmitMeta: TSubmitMeta; ``` Defined in: [packages/form-core/src/FormApi.ts:444](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L444) onSubmitMeta, the data passed from the handleSubmit handler, to the onSubmit function props #### Inherited from [`BaseFormOptions`](BaseFormOptions.md).[`onSubmitMeta`](BaseFormOptions.md#onsubmitmeta) *** ### transform()? ```ts optional transform: (data) => unknown; ``` Defined in: [packages/form-core/src/FormApi.ts:582](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L582) #### Parameters ##### data `unknown` #### Returns `unknown` *** ### validationLogic? ```ts optional validationLogic: ValidationLogicFn; ``` Defined in: [packages/form-core/src/FormApi.ts:514](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L514) *** ### validators? ```ts optional validators: FormValidators; ``` Defined in: [packages/form-core/src/FormApi.ts:501](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L501) A list of validators to pass to the form