File: fieldvalidators.md | Updated: 11/15/2025
Search...
+ K
Auto
Docs Examples GitHub Contributors
Docs Examples GitHub Contributors
Docs Examples GitHub Contributors
Docs Examples Github Contributors
Docs Examples Github Contributors
Docs Examples Github Contributors
Docs Examples Github Contributors
Docs Examples Github Contributors
Maintainers Partners Support Learn StatsBETA Discord Merch Blog GitHub Ethos Brand Guide
Documentation
Framework
React
Version
Latest
Search...
+ K
Menu
Getting Started
Guides
API Reference
Examples
Framework
React
Version
Latest
Menu
Getting Started
Guides
API Reference
Examples
On this page
Copy Markdown
Defined in: packages/form-core/src/FieldApi.ts:286
Type Parameters
---------------
• TParentData
• TName extends DeepKeys <TParentData>
• TData extends DeepValue <TParentData, TName>
• TOnMount extends undefined | FieldValidateOrFn<TParentData, TName, TData>
• TOnChange extends undefined | FieldValidateOrFn<TParentData, TName, TData>
• TOnChangeAsync extends undefined | FieldAsyncValidateOrFn<TParentData, TName, TData>
• TOnBlur extends undefined | FieldValidateOrFn<TParentData, TName, TData>
• TOnBlurAsync extends undefined | FieldAsyncValidateOrFn<TParentData, TName, TData>
• TOnSubmit extends undefined | FieldValidateOrFn<TParentData, TName, TData>
• TOnSubmitAsync extends undefined | FieldAsyncValidateOrFn<TParentData, TName, TData>
• TOnDynamic extends undefined | FieldValidateOrFn<TParentData, TName, TData>
• TOnDynamicAsync extends undefined | FieldAsyncValidateOrFn<TParentData, TName, TData>
Properties
----------
### onBlur?
ts
optional onBlur: TOnBlur;
optional onBlur: TOnBlur;
Defined in: packages/form-core/src/FieldApi.ts:339
An optional function, that runs on the blur event of input.
ts
z.string().min(1)
z.string().min(1)
ts
optional onBlurAsync: TOnBlurAsync;
optional onBlurAsync: TOnBlurAsync;
Defined in: packages/form-core/src/FieldApi.ts:345
An optional property similar to onBlur but async validation.
ts
z.string().refine(async (val) => val.length > 3, { message: 'Testing 123' })
z.string().refine(async (val) => val.length > 3, { message: 'Testing 123' })
ts
optional onBlurAsyncDebounceMs: number;
optional onBlurAsyncDebounceMs: number;
Defined in: packages/form-core/src/FieldApi.ts:352
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
ts
optional onBlurListenTo: DeepKeys<TParentData>[];
optional onBlurListenTo: DeepKeys<TParentData>[];
Defined in: packages/form-core/src/FieldApi.ts:356
An optional list of field names that should trigger this field's onBlur and onBlurAsync events when its value changes
ts
optional onChange: TOnChange;
optional onChange: TOnChange;
Defined in: packages/form-core/src/FieldApi.ts:317
An optional function, that runs on the change event of input.
ts
z.string().min(1)
z.string().min(1)
ts
optional onChangeAsync: TOnChangeAsync;
optional onChangeAsync: TOnChangeAsync;
Defined in: packages/form-core/src/FieldApi.ts:323
An optional property similar to onChange but async validation
ts
z.string().refine(async (val) => val.length > 3, { message: 'Testing 123' })
z.string().refine(async (val) => val.length > 3, { message: 'Testing 123' })
ts
optional onChangeAsyncDebounceMs: number;
optional onChangeAsyncDebounceMs: number;
Defined in: packages/form-core/src/FieldApi.ts:329
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
ts
optional onChangeListenTo: DeepKeys<TParentData>[];
optional onChangeListenTo: DeepKeys<TParentData>[];
Defined in: packages/form-core/src/FieldApi.ts:333
An optional list of field names that should trigger this field's onChange and onChangeAsync events when its value changes
ts
optional onDynamic: TOnDynamic;
optional onDynamic: TOnDynamic;
Defined in: packages/form-core/src/FieldApi.ts:369
ts
optional onDynamicAsync: TOnDynamicAsync;
optional onDynamicAsync: TOnDynamicAsync;
Defined in: packages/form-core/src/FieldApi.ts:370
ts
optional onDynamicAsyncDebounceMs: number;
optional onDynamicAsyncDebounceMs: number;
Defined in: packages/form-core/src/FieldApi.ts:371
ts
optional onMount: TOnMount;
optional onMount: TOnMount;
Defined in: packages/form-core/src/FieldApi.ts:311
An optional function, that runs on the mount event of input.
ts
optional onSubmit: TOnSubmit;
optional onSubmit: TOnSubmit;
Defined in: packages/form-core/src/FieldApi.ts:362
An optional function, that runs on the submit event of form.
ts
z.string().min(1)
z.string().min(1)
ts
optional onSubmitAsync: TOnSubmitAsync;
optional onSubmitAsync: TOnSubmitAsync;
Defined in: packages/form-core/src/FieldApi.ts:368
An optional property similar to onSubmit but async validation.
ts
z.string().refine(async (val) => val.length > 3, { message: 'Testing 123' })
z.string().refine(async (val) => val.length > 3, { message: 'Testing 123' })
