Interface: FieldValidators<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync>#

Defined in: packages/form-core/src/FieldApi.ts:292

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: RejectPromiseValidator<TOnBlur>;

optional onBlur: RejectPromiseValidator<TOnBlur>;

Defined in: packages/form-core/src/FieldApi.ts:345

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

Example#

z.string().min(1)

z.string().min(1)

onBlurAsync?#

optional onBlurAsync: TOnBlurAsync;

optional onBlurAsync: TOnBlurAsync;

Defined in: packages/form-core/src/FieldApi.ts:351

An optional property similar to onBlur but async validation.

Example#

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

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

onBlurAsyncDebounceMs?#

optional onBlurAsyncDebounceMs: number;

optional onBlurAsyncDebounceMs: number;

Defined in: packages/form-core/src/FieldApi.ts:358

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>[];

optional onBlurListenTo: DeepKeys<TParentData>[];

Defined in: packages/form-core/src/FieldApi.ts:362

An optional list of field names that should trigger this field's onBlur and onBlurAsync events when its value changes

onChange?#

optional onChange: RejectPromiseValidator<TOnChange>;

optional onChange: RejectPromiseValidator<TOnChange>;

Defined in: packages/form-core/src/FieldApi.ts:323

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

Example#

z.string().min(1)

z.string().min(1)

onChangeAsync?#

optional onChangeAsync: TOnChangeAsync;

optional onChangeAsync: TOnChangeAsync;

Defined in: packages/form-core/src/FieldApi.ts:329

An optional property similar to onChange but async validation

Example#

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

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

onChangeAsyncDebounceMs?#

optional onChangeAsyncDebounceMs: number;

optional onChangeAsyncDebounceMs: number;

Defined in: packages/form-core/src/FieldApi.ts:335

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>[];

optional onChangeListenTo: DeepKeys<TParentData>[];

Defined in: packages/form-core/src/FieldApi.ts:339

An optional list of field names that should trigger this field's onChange and onChangeAsync events when its value changes

onDynamic?#

optional onDynamic: RejectPromiseValidator<TOnDynamic>;

optional onDynamic: RejectPromiseValidator<TOnDynamic>;

Defined in: packages/form-core/src/FieldApi.ts:375

onDynamicAsync?#

optional onDynamicAsync: TOnDynamicAsync;

optional onDynamicAsync: TOnDynamicAsync;

Defined in: packages/form-core/src/FieldApi.ts:376

onDynamicAsyncDebounceMs?#

optional onDynamicAsyncDebounceMs: number;

optional onDynamicAsyncDebounceMs: number;

Defined in: packages/form-core/src/FieldApi.ts:377

onMount?#

optional onMount: RejectPromiseValidator<TOnMount>;

optional onMount: RejectPromiseValidator<TOnMount>;

Defined in: packages/form-core/src/FieldApi.ts:317

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

onSubmit?#

optional onSubmit: RejectPromiseValidator<TOnSubmit>;

optional onSubmit: RejectPromiseValidator<TOnSubmit>;

Defined in: packages/form-core/src/FieldApi.ts:368

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

Example#

z.string().min(1)

z.string().min(1)

onSubmitAsync?#

optional onSubmitAsync: TOnSubmitAsync;

optional onSubmitAsync: TOnSubmitAsync;

Defined in: packages/form-core/src/FieldApi.ts:374

An optional property similar to onSubmit but async validation.

Example#

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

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