On this page
- Interface: FormOptions<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>
- Extends
- Type Parameters
- Properties
- asyncAlways?
- asyncDebounceMs?
- canSubmitWhenInvalid?
- defaultState?
- defaultValues?
- Inherited from
- formId?
- listeners?
- onSubmit()?
- Parameters
- props
- formApi
- meta
- value
- Returns
- onSubmitInvalid()?
- Parameters
- props
- formApi
- meta
- value
- Returns
- onSubmitMeta?
- Inherited from
- transform?
- validationLogic?
- validators?
FormOptions
Interface: FormOptions<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>
Defined in: packages/form-core/src/FormApi.ts:369
An object representing the options for a form.
Extends
- BaseFormOptions<TFormData, TSubmitMeta>
Type Parameters
• 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
Properties
asyncAlways?
optional asyncAlways: boolean;
optional asyncAlways: boolean;
Defined in: packages/form-core/src/FormApi.ts:408
If true, always run async validation, even when sync validation has produced an error. Defaults to undefined.
asyncDebounceMs?
optional asyncDebounceMs: number;
optional asyncDebounceMs: number;
Defined in: packages/form-core/src/FormApi.ts:412
Optional time in milliseconds if you want to introduce a delay before firing off an async action.
canSubmitWhenInvalid?
optional canSubmitWhenInvalid: boolean;
optional canSubmitWhenInvalid: boolean;
Defined in: packages/form-core/src/FormApi.ts:416
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>>;
optional defaultState: Partial<FormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer>>;
Defined in: packages/form-core/src/FormApi.ts:390
The default state for the form.
defaultValues?
optional defaultValues: TFormData;
optional defaultValues: TFormData;
Defined in: packages/form-core/src/FormApi.ts:359
Set initial values for your form.
Inherited from
formId?
optional formId: string;
optional formId: string;
Defined in: packages/form-core/src/FormApi.ts:386
The form name, used for devtools and identification
listeners?
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:438
form level listeners
onSubmit()?
optional onSubmit: (props) => any;
optional onSubmit: (props) => any;
Defined in: packages/form-core/src/FormApi.ts:456
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;
optional onSubmitInvalid: (props) => void;
Defined in: packages/form-core/src/FormApi.ts:477
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;
optional onSubmitMeta: TSubmitMeta;
Defined in: packages/form-core/src/FormApi.ts:363
onSubmitMeta, the data passed from the handleSubmit handler, to the onSubmit function props
Inherited from
transform?
optional transform: FormTransform<NoInfer<TFormData>, NoInfer<TOnMount>, NoInfer<TOnChange>, NoInfer<TOnChangeAsync>, NoInfer<TOnBlur>, NoInfer<TOnBlurAsync>, NoInfer<TOnSubmit>, NoInfer<TOnSubmitAsync>, NoInfer<TOnDynamic>, NoInfer<TOnDynamicAsync>, NoInfer<TOnServer>, NoInfer<TSubmitMeta>>;
optional transform: FormTransform<NoInfer<TFormData>, NoInfer<TOnMount>, NoInfer<TOnChange>, NoInfer<TOnChangeAsync>, NoInfer<TOnBlur>, NoInfer<TOnBlurAsync>, NoInfer<TOnSubmit>, NoInfer<TOnSubmitAsync>, NoInfer<TOnDynamic>, NoInfer<TOnDynamicAsync>, NoInfer<TOnServer>, NoInfer<TSubmitMeta>>;
Defined in: packages/form-core/src/FormApi.ts:495
validationLogic?
optional validationLogic: ValidationLogicFn;
optional validationLogic: ValidationLogicFn;
Defined in: packages/form-core/src/FormApi.ts:433
validators?
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:420
A list of validators to pass to the form
Subscribe to Bytes
Your weekly dose of JavaScript news. Delivered every Monday to over 100,000 devs, for free.
Subscribe to Bytes
Your weekly dose of JavaScript news. Delivered every Monday to over 100,000 devs, for free.