Skip to content
Source
Sign inSign up
TanStack/form
Open History to see the last commit

fieldvalidators.md

218 lines6.6 KB

Interface: FieldValidators<TParentData, TName, TFieldValidator, TFormValidator, TData>

Type Parameters

• TParentData

• TName extends DeepKeys<TParentData>

• TFieldValidator extends Validator<DeepValue<TParentData, TName>, unknown> | undefined = undefined

• TFormValidator extends Validator<TParentData, unknown> | undefined = undefined

• TData extends DeepValue<TParentData, TName> = DeepValue<TParentData, TName>

Properties

onBlur?

optional onBlur: FieldValidateOrFn<TParentData, TName, TFieldValidator, TFormValidator, TData>;

An optional function, that runs on the blur event of input. If validatorAdapter is passed, this may also accept a property from the respective adapter

Example

z.string().min(1) // if `zodAdapter` is passed

Defined in

packages/form-core/src/FieldApi.ts:199


onBlurAsync?

optional onBlurAsync: FieldAsyncValidateOrFn<TParentData, TName, TFieldValidator, TFormValidator, TData>;

An optional property similar to onBlur but async validation. If validatorAdapter is passed, this may also accept a property from the respective adapter

Example

z.string().refine(async (val) => val.length > 3, { message: 'Testing 123' }) // if `zodAdapter` is passed

Defined in

packages/form-core/src/FieldApi.ts:212


onBlurAsyncDebounceMs?

optional onBlurAsyncDebounceMs: number;

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

Defined in

packages/form-core/src/FieldApi.ts:225


onBlurListenTo?

optional onBlurListenTo: unknown extends TParentData ? string : TParentData extends readonly any[] & IsTuple<TParentData> ? PrefixTupleAccessor<TParentData<TParentData>, AllowedIndexes<TParentData<TParentData>, never>, []> : TParentData extends any[] ? PrefixArrayAccessor<TParentData<TParentData>, [any]> : TParentData extends Date ? never : TParentData extends object ? PrefixObjectAccessor<TParentData<TParentData>, []> : TParentData extends string | number | bigint | boolean ? "" : never[];

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

Defined in

packages/form-core/src/FieldApi.ts:229


onChange?

optional onChange: FieldValidateOrFn<TParentData, TName, TFieldValidator, TFormValidator, TData>;

An optional property that takes a ValidateFn which is a generic of TData and TParentData. If validatorAdapter is passed, this may also accept a property from the respective adapter

Example

z.string().min(1) // if `zodAdapter` is passed

Defined in

packages/form-core/src/FieldApi.ts:163


onChangeAsync?

optional onChangeAsync: FieldAsyncValidateOrFn<TParentData, TName, TFieldValidator, TFormValidator, TData>;

An optional property similar to onChange but async validation. If validatorAdapter is passed, this may also accept a property from the respective adapter

Example

z.string().refine(async (val) => val.length > 3, { message: 'Testing 123' }) // if `zodAdapter` is passed

Defined in

packages/form-core/src/FieldApi.ts:176


onChangeAsyncDebounceMs?

optional onChangeAsyncDebounceMs: number;

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

Defined in

packages/form-core/src/FieldApi.ts:188


onChangeListenTo?

optional onChangeListenTo: unknown extends TParentData ? string : TParentData extends readonly any[] & IsTuple<TParentData> ? PrefixTupleAccessor<TParentData<TParentData>, AllowedIndexes<TParentData<TParentData>, never>, []> : TParentData extends any[] ? PrefixArrayAccessor<TParentData<TParentData>, [any]> : TParentData extends Date ? never : TParentData extends object ? PrefixObjectAccessor<TParentData<TParentData>, []> : TParentData extends string | number | bigint | boolean ? "" : never[];

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

Defined in

packages/form-core/src/FieldApi.ts:192


onMount?

optional onMount: FieldValidateOrFn<TParentData, TName, TFieldValidator, TFormValidator, TData>;

An optional function that takes a param of formApi which is a generic type of TData and TParentData

Defined in

packages/form-core/src/FieldApi.ts:150


onSubmit?

optional onSubmit: FieldValidateOrFn<TParentData, TName, TFieldValidator, TFormValidator, TData>;

An optional function, that runs on the submit event of form. If validatorAdapter is passed, this may also accept a property from the respective adapter

Example

z.string().min(1) // if `zodAdapter` is passed

Defined in

packages/form-core/src/FieldApi.ts:236


onSubmitAsync?

optional onSubmitAsync: FieldAsyncValidateOrFn<TParentData, TName, TFieldValidator, TFormValidator, TData>;

An optional property similar to onSubmit but async validation. If validatorAdapter is passed, this may also accept a property from the respective adapter

Example

z.string().refine(async (val) => val.length > 3, { message: 'Testing 123' }) // if `zodAdapter` is passed

Defined in

packages/form-core/src/FieldApi.ts:249