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

An object representing the options for a form.

• BaseFormOptions<TFormData, TSubmitMeta>

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>

TOnDynamic extends undefined | FormValidateOrFn<TFormData>

TOnDynamicAsync 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:366

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

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

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, 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:348

The default state for the form.

optional defaultValues: TFormData;

optional defaultValues: TFormData;

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

Set initial values for your form.

BaseFormOptions.defaultValues

optional formId: string;

optional formId: string;

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

The form name, used for devtools and identification

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

form level listeners

optional onSubmit: (props) => any;

optional onSubmit: (props) => any;

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

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, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>

TSubmitMeta

TFormData

any

optional onSubmitInvalid: (props) => void;

optional onSubmitInvalid: (props) => void;

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

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

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

TSubmitMeta

TFormData

void

optional onSubmitMeta: TSubmitMeta;

optional onSubmitMeta: TSubmitMeta;

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

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

BaseFormOptions.onSubmitMeta

optional transform: (data) => unknown;

optional transform: (data) => unknown;

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

unknown

unknown

optional validationLogic: ValidationLogicFn;

optional validationLogic: ValidationLogicFn;

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

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

A list of validators to pass to the form