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

An object representing the options for a form.

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

• TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>

• TSubmitMeta = never

optional asyncAlways: boolean;

optional asyncAlways: boolean;

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

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:278

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

optional canSubmitWhenInvalid: boolean;

optional canSubmitWhenInvalid: boolean;

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

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

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

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

The default state for the form.

optional defaultValues: TFormData;

optional defaultValues: TFormData;

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

Set initial values for your form.

optional onSubmit: (props) => any;

optional onSubmit: (props) => any;

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

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, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer, TSubmitMeta>

TSubmitMeta

TFormData

any

optional onSubmitInvalid: (props) => void;

optional onSubmitInvalid: (props) => void;

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

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

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

TFormData

void

optional onSubmitMeta: TSubmitMeta;

optional onSubmitMeta: TSubmitMeta;

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

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

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

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

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

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

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

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

A list of validators to pass to the form