Documentation
Framework
Version
API Reference

FormValidators

Interface: FormValidators<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync>

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

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>

Properties

onBlur?

optional onBlur: TOnBlur;
optional onBlur: TOnBlur;

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

Optional function that validates the form data when a field loses focus, returns a FormValidationError


onBlurAsync?

optional onBlurAsync: TOnBlurAsync;
optional onBlurAsync: TOnBlurAsync;

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

Optional onBlur asynchronous validation method for when a field loses focus returns a FormValidationError or a promise of Promise<FormValidationError>


onBlurAsyncDebounceMs?

optional onBlurAsyncDebounceMs: number;
optional onBlurAsyncDebounceMs: number;

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

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;
optional onChange: TOnChange;

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

Optional function that checks the validity of your data whenever a value changes


onChangeAsync?

optional onChangeAsync: TOnChangeAsync;
optional onChangeAsync: TOnChangeAsync;

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

Optional onChange asynchronous counterpart to onChange. Useful for more complex validation logic that might involve server requests.


onChangeAsyncDebounceMs?

optional onChangeAsyncDebounceMs: number;
optional onChangeAsyncDebounceMs: number;

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

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.


onDynamic?

optional onDynamic: TOnDynamic;
optional onDynamic: TOnDynamic;

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


onDynamicAsync?

optional onDynamicAsync: TOnDynamicAsync;
optional onDynamicAsync: TOnDynamicAsync;

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


onDynamicAsyncDebounceMs?

optional onDynamicAsyncDebounceMs: number;
optional onDynamicAsyncDebounceMs: number;

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


onMount?

optional onMount: TOnMount;
optional onMount: TOnMount;

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

Optional function that fires as soon as the component mounts.


onSubmit?

optional onSubmit: TOnSubmit;
optional onSubmit: TOnSubmit;

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


onSubmitAsync?

optional onSubmitAsync: TOnSubmitAsync;
optional onSubmitAsync: TOnSubmitAsync;

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

Our Partners
Code Rabbit
Cloudflare
Subscribe to Bytes

Your weekly dose of JavaScript news. Delivered every Monday to over 100,000 devs, for free.

Bytes

No spam. Unsubscribe at any time.

Subscribe to Bytes

Your weekly dose of JavaScript news. Delivered every Monday to over 100,000 devs, for free.

Bytes

No spam. Unsubscribe at any time.