FieldValidators

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?

ts
optional onBlur: TOnBlur;
optional onBlur: TOnBlur;

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

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

Example

ts
z.string().min(1)
z.string().min(1)

onBlurAsync?

ts
optional onBlurAsync: TOnBlurAsync;
optional onBlurAsync: TOnBlurAsync;

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

An optional property similar to onBlur but async validation.

Example

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

onBlurAsyncDebounceMs?

ts
optional onBlurAsyncDebounceMs: number;
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?

ts
optional onBlurListenTo: DeepKeys<TParentData>[];
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?

ts
optional onChange: TOnChange;
optional onChange: TOnChange;

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

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

Example

ts
z.string().min(1)
z.string().min(1)

onChangeAsync?

ts
optional onChangeAsync: TOnChangeAsync;
optional onChangeAsync: TOnChangeAsync;

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

An optional property similar to onChange but async validation

Example

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

onChangeAsyncDebounceMs?

ts
optional onChangeAsyncDebounceMs: number;
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?

ts
optional onChangeListenTo: DeepKeys<TParentData>[];
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?

ts
optional onDynamic: TOnDynamic;
optional onDynamic: TOnDynamic;

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


onDynamicAsync?

ts
optional onDynamicAsync: TOnDynamicAsync;
optional onDynamicAsync: TOnDynamicAsync;

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


onDynamicAsyncDebounceMs?

ts
optional onDynamicAsyncDebounceMs: number;
optional onDynamicAsyncDebounceMs: number;

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


onMount?

ts
optional onMount: TOnMount;
optional onMount: TOnMount;

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

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


onSubmit?

ts
optional onSubmit: TOnSubmit;
optional onSubmit: TOnSubmit;

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

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

Example

ts
z.string().min(1)
z.string().min(1)

onSubmitAsync?

ts
optional onSubmitAsync: TOnSubmitAsync;
optional onSubmitAsync: TOnSubmitAsync;

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

An optional property similar to onSubmit but async validation.

Example

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

Your weekly dose of JavaScript news. Delivered every Monday to over 100,000 devs, for free.

Bytes

No spam. Unsubscribe at any time.

Subscribe to Bytes

Your weekly dose of JavaScript news. Delivered every Monday to over 100,000 devs, for free.

Bytes

No spam. Unsubscribe at any time.