6.3 KiB
| id | title |
|---|---|
| FormOptions | FormOptions |
Interface: FormOptions<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>
Defined in: packages/form-core/src/FormApi.ts:351
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:390
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:394
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:398
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:372
The default state for the form.
defaultValues?
optional defaultValues: TFormData;
Defined in: packages/form-core/src/FormApi.ts:341
Set initial values for your form.
Inherited from
formId?
optional formId: string;
Defined in: packages/form-core/src/FormApi.ts:368
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:420
form level listeners
onSubmit()?
optional onSubmit: (props) => any;
Defined in: packages/form-core/src/FormApi.ts:438
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:459
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:345
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:483
Parameters
data
unknown
Returns
unknown
validationLogic?
optional validationLogic: ValidationLogicFn;
Defined in: packages/form-core/src/FormApi.ts:415
validators?
optional validators: FormValidators<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync>;
Defined in: packages/form-core/src/FormApi.ts:402
A list of validators to pass to the form