FormGroupValidators

Defined in: packages/form-core/src/FormGroupApi.ts:199

Type Parameters

TParentData

TParentData

TName

TName extends DeepKeys<TParentData>

TData

TData extends DeepValue<TParentData, TName>

TOnMount

TOnMount extends undefined | FormGroupValidateOrFn<TParentData, TName, TData>

TOnChange

TOnChange extends undefined | FormGroupValidateOrFn<TParentData, TName, TData>

TOnChangeAsync

TOnChangeAsync extends | undefined | FormGroupAsyncValidateOrFn<TParentData, TName, TData>

TOnBlur

TOnBlur extends undefined | FormGroupValidateOrFn<TParentData, TName, TData>

TOnBlurAsync

TOnBlurAsync extends | undefined | FormGroupAsyncValidateOrFn<TParentData, TName, TData>

TOnSubmit

TOnSubmit extends undefined | FormGroupValidateOrFn<TParentData, TName, TData>

TOnSubmitAsync

TOnSubmitAsync extends | undefined | FormGroupAsyncValidateOrFn<TParentData, TName, TData>

TOnDynamic

TOnDynamic extends undefined | FormGroupValidateOrFn<TParentData, TName, TData>

TOnDynamicAsync

TOnDynamicAsync extends | undefined | FormGroupAsyncValidateOrFn<TParentData, TName, TData>

Properties

onBlur?

optional onBlur: TOnBlur;

Defined in: packages/form-core/src/FormGroupApi.ts:258

An optional function, that runs on the blur event of input.

Example

z.string().min(1)

onBlurAsync?

optional onBlurAsync: TOnBlurAsync;

Defined in: packages/form-core/src/FormGroupApi.ts:264

An optional property similar to onBlur but async validation.

Example

z.string().refine(async (val) => val.length > 3, { message: 'Testing 123' })

onBlurAsyncDebounceMs?

optional onBlurAsyncDebounceMs: number;

Defined in: packages/form-core/src/FormGroupApi.ts:271

An optional number to represent how long the onBlurAsync should wait before running

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/FormGroupApi.ts:236

An optional function, that runs on the change event of input.

Example

z.string().min(1)

onChangeAsync?

optional onChangeAsync: TOnChangeAsync;

Defined in: packages/form-core/src/FormGroupApi.ts:242

An optional property similar to onChange but async validation

Example

z.string().refine(async (val) => val.length > 3, { message: 'Testing 123' })

onChangeAsyncDebounceMs?

optional onChangeAsyncDebounceMs: number;

Defined in: packages/form-core/src/FormGroupApi.ts:248

An optional number to represent how long the onChangeAsync should wait before running

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;

Defined in: packages/form-core/src/FormGroupApi.ts:288

onDynamicAsync?

optional onDynamicAsync: TOnDynamicAsync;

Defined in: packages/form-core/src/FormGroupApi.ts:289

onDynamicAsyncDebounceMs?

optional onDynamicAsyncDebounceMs: number;

Defined in: packages/form-core/src/FormGroupApi.ts:290

onMount?

optional onMount: TOnMount;

Defined in: packages/form-core/src/FormGroupApi.ts:230

An optional function, that runs on the mount event of input.

onSubmit?

optional onSubmit: TOnSubmit;

Defined in: packages/form-core/src/FormGroupApi.ts:281

An optional function, that runs on the submit event of form.

Example

z.string().min(1)

onSubmitAsync?

optional onSubmitAsync: TOnSubmitAsync;

Defined in: packages/form-core/src/FormGroupApi.ts:287

An optional property similar to onSubmit but async validation.

Example

z.string().refine(async (val) => val.length > 3, { message: 'Testing 123' })