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

fieldvalidators.md

204 lines6.0 KB

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

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

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>

Properties

onBlur?

optional onBlur: TOnBlur;

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

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:322

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:329

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

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

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:294

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:300

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:306

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

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

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


onMount?

optional onMount: TOnMount;

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

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


onSubmit?

optional onSubmit: TOnSubmit;

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

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:345

An optional property similar to onSubmit but async validation.

Example

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