Interface: FormValidators<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync>#
Defined in: packages/form-core/src/FormApi.ts:150
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>
Properties#
onBlur?#
optional onBlur: TOnBlur;
Defined in: packages/form-core/src/FormApi.ts:179
Optional function that validates the form data when a field loses focus, returns a FormValidationError
onBlurAsync?#
optional onBlurAsync: TOnBlurAsync;
Defined in: packages/form-core/src/FormApi.ts:183
Optional onBlur asynchronous validation method for when a field loses focus returns a FormValidationError or a promise of Promise<FormValidationError>
onBlurAsyncDebounceMs?#
optional onBlurAsyncDebounceMs: number;
Defined in: packages/form-core/src/FormApi.ts:187
The default time in milliseconds that if set to a number larger than 0, will debounce the async validation event by this length of time in milliseconds.
onChange?#
optional onChange: TOnChange;
Defined in: packages/form-core/src/FormApi.ts:167
Optional function that checks the validity of your data whenever a value changes
onChangeAsync?#
optional onChangeAsync: TOnChangeAsync;
Defined in: packages/form-core/src/FormApi.ts:171
Optional onChange asynchronous counterpart to onChange. Useful for more complex validation logic that might involve server requests.
onChangeAsyncDebounceMs?#
optional onChangeAsyncDebounceMs: number;
Defined in: packages/form-core/src/FormApi.ts:175
The default time in milliseconds that if set to a number larger than 0, will debounce the async validation event by this length of time in milliseconds.
onMount?#
optional onMount: TOnMount;
Defined in: packages/form-core/src/FormApi.ts:163
Optional function that fires as soon as the component mounts.
onSubmit?#
optional onSubmit: TOnSubmit;
Defined in: packages/form-core/src/FormApi.ts:188
onSubmitAsync?#
optional onSubmitAsync: TOnSubmitAsync;
Defined in: packages/form-core/src/FormApi.ts:189