Interface: FieldValidators<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync>#
Defined in: packages/form-core/src/FieldApi.ts:287
Type Parameters#
TParentData#
TParentData
TName#
TName extends DeepKeys<TParentData>
TData#
TData extends DeepValue<TParentData, TName>
TOnMount#
TOnMount extends undefined | FieldValidateOrFn<TParentData, TName, TData>
TOnChange#
TOnChange extends undefined | FieldValidateOrFn<TParentData, TName, TData>
TOnChangeAsync#
TOnChangeAsync extends undefined | FieldAsyncValidateOrFn<TParentData, TName, TData>
TOnBlur#
TOnBlur extends undefined | FieldValidateOrFn<TParentData, TName, TData>
TOnBlurAsync#
TOnBlurAsync extends undefined | FieldAsyncValidateOrFn<TParentData, TName, TData>
TOnSubmit#
TOnSubmit extends undefined | FieldValidateOrFn<TParentData, TName, TData>
TOnSubmitAsync#
TOnSubmitAsync extends undefined | FieldAsyncValidateOrFn<TParentData, TName, TData>
TOnDynamic#
TOnDynamic extends undefined | FieldValidateOrFn<TParentData, TName, TData>
TOnDynamicAsync#
TOnDynamicAsync extends undefined | FieldAsyncValidateOrFn<TParentData, TName, TData>
Properties#
onBlur?#
optional onBlur: TOnBlur;
Defined in: packages/form-core/src/FieldApi.ts:340
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/FieldApi.ts:346
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/FieldApi.ts:353
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
onBlurListenTo?#
optional onBlurListenTo: DeepKeys<TParentData>[];
Defined in: packages/form-core/src/FieldApi.ts:357
An optional list of field names that should trigger this field's onBlur and onBlurAsync events when its value changes
onChange?#
optional onChange: TOnChange;
Defined in: packages/form-core/src/FieldApi.ts:318
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/FieldApi.ts:324
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/FieldApi.ts:330
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
onChangeListenTo?#
optional onChangeListenTo: DeepKeys<TParentData>[];
Defined in: packages/form-core/src/FieldApi.ts:334
An optional list of field names that should trigger this field's onChange and onChangeAsync events when its value changes
onDynamic?#
optional onDynamic: TOnDynamic;
Defined in: packages/form-core/src/FieldApi.ts:370
onDynamicAsync?#
optional onDynamicAsync: TOnDynamicAsync;
Defined in: packages/form-core/src/FieldApi.ts:371
onDynamicAsyncDebounceMs?#
optional onDynamicAsyncDebounceMs: number;
Defined in: packages/form-core/src/FieldApi.ts:372
onMount?#
optional onMount: TOnMount;
Defined in: packages/form-core/src/FieldApi.ts:312
An optional function, that runs on the mount event of input.
onSubmit?#
optional onSubmit: TOnSubmit;
Defined in: packages/form-core/src/FieldApi.ts:363
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/FieldApi.ts:369
An optional property similar to onSubmit but async validation.
Example#
z.string().refine(async (val) => val.length > 3, { message: 'Testing 123' })