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

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

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>

Properties

onBlur?

optional onBlur: TOnBlur;

optional onBlur: TOnBlur;

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

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:208

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:212

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:192

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:196

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:200

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:215

onDynamicAsync?

optional onDynamicAsync: TOnDynamicAsync;

optional onDynamicAsync: TOnDynamicAsync;

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

onDynamicAsyncDebounceMs?

optional onDynamicAsyncDebounceMs: number;

optional onDynamicAsyncDebounceMs: number;

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

onMount?

optional onMount: TOnMount;

optional onMount: TOnMount;

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

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:213

onSubmitAsync?

optional onSubmitAsync: TOnSubmitAsync;

optional onSubmitAsync: TOnSubmitAsync;

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