Interface: FormOptions<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>#
Defined in: packages/form-core/src/FormApi.ts:328
An object representing the options for a form.
Extends#
BaseFormOptions<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?#
optional asyncAlways: boolean;
Defined in: packages/form-core/src/FormApi.ts:367
If true, always run async validation, even when sync validation has produced an error. Defaults to undefined.
asyncDebounceMs?#
optional asyncDebounceMs: number;
Defined in: packages/form-core/src/FormApi.ts:371
Optional time in milliseconds if you want to introduce a delay before firing off an async action.
canSubmitWhenInvalid?#
optional canSubmitWhenInvalid: boolean;
Defined in: packages/form-core/src/FormApi.ts:375
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?#
optional defaultState: Partial<FormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer>>;
Defined in: packages/form-core/src/FormApi.ts:349
The default state for the form.
defaultValues?#
optional defaultValues: TFormData;
Defined in: packages/form-core/src/FormApi.ts:318
Set initial values for your form.
Inherited from#
formId?#
optional formId: string;
Defined in: packages/form-core/src/FormApi.ts:345
The form name, used for devtools and identification
listeners?#
optional listeners: FormListeners<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>;
Defined in: packages/form-core/src/FormApi.ts:397
form level listeners
onSubmit()?#
optional onSubmit: (props) => any;
Defined in: packages/form-core/src/FormApi.ts:415
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>
meta#
TSubmitMeta
value#
TFormData
Returns#
any
onSubmitInvalid()?#
optional onSubmitInvalid: (props) => void;
Defined in: packages/form-core/src/FormApi.ts:436
Specify an action for scenarios where the user tries to submit an invalid form.
Parameters#
props#
formApi#
FormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>
meta#
TSubmitMeta
value#
TFormData
Returns#
void
onSubmitMeta?#
optional onSubmitMeta: TSubmitMeta;
Defined in: packages/form-core/src/FormApi.ts:322
onSubmitMeta, the data passed from the handleSubmit handler, to the onSubmit function props
Inherited from#
transform()?#
optional transform: (data) => unknown;
Defined in: packages/form-core/src/FormApi.ts:460
Parameters#
data#
unknown
Returns#
unknown
validationLogic?#
optional validationLogic: ValidationLogicFn;
Defined in: packages/form-core/src/FormApi.ts:392
validators?#
optional validators: FormValidators<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync>;
Defined in: packages/form-core/src/FormApi.ts:379
A list of validators to pass to the form