Skip to content
Source
Sign inSign up
TanStack/form
Open History to see the last commit

formoptions.md

162 lines3.2 KB

Interface: FormOptions<TFormData, TFormValidator>

An object representing the options for a form.

Type Parameters

• TFormData

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

Properties

asyncAlways?

optional asyncAlways: boolean;

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

Defined in

packages/form-core/src/FormApi.ts:154


asyncDebounceMs?

optional asyncDebounceMs: number;

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

Defined in

packages/form-core/src/FormApi.ts:158


defaultState?

optional defaultState: Partial<FormState<TFormData>>;

The default state for the form.

Defined in

packages/form-core/src/FormApi.ts:150


defaultValues?

optional defaultValues: TFormData;

Set initial values for your form.

Defined in

packages/form-core/src/FormApi.ts:146


onSubmit()?

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>

Parameters

• props

• props.formApi: FormApi<TFormData, TFormValidator>

• props.value: TFormData

Returns

any

Defined in

packages/form-core/src/FormApi.ts:170


onSubmitInvalid()?

optional onSubmitInvalid: (props) => void;

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

Parameters

• props

• props.formApi: FormApi<TFormData, TFormValidator>

• props.value: TFormData

Returns

void

Defined in

packages/form-core/src/FormApi.ts:177


transform?

optional transform: FormTransform<TFormData, TFormValidator>;

Defined in

packages/form-core/src/FormApi.ts:181


validatorAdapter?

optional validatorAdapter: TFormValidator;

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

Defined in

packages/form-core/src/FormApi.ts:162


validators?

optional validators: FormValidators<TFormData, TFormValidator>;

A list of validators to pass to the form

Defined in

packages/form-core/src/FormApi.ts:166