FieldValidators

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

定义于: packages/form-core/src/FieldApi.ts:272

类型参数

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>

属性

onBlur?

ts
optional onBlur: TOnBlur;
optional onBlur: TOnBlur;

定义于: packages/form-core/src/FieldApi.ts:321

一个可选函数,在输入的失焦事件上运行。

示例

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

onBlurAsync?

ts
optional onBlurAsync: TOnBlurAsync;
optional onBlurAsync: TOnBlurAsync;

定义于: packages/form-core/src/FieldApi.ts:327

一个可选属性,类似于 onBlur,但用于异步校验。

示例

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

onBlurAsyncDebounceMs?

ts
optional onBlurAsyncDebounceMs: number;
optional onBlurAsyncDebounceMs: number;

定义于: packages/form-core/src/FieldApi.ts:334

一个可选数字,表示 onBlurAsync 在运行前应等待多长时间。

如果设置为大于 0 的数字,将按此毫秒长度对异步校验事件进行防抖处理。


onBlurListenTo?

ts
optional onBlurListenTo: DeepKeys<TParentData>[];
optional onBlurListenTo: DeepKeys<TParentData>[];

定义于: packages/form-core/src/FieldApi.ts:338

一个可选的字段名称列表,当其值更改时,应触发此字段的 onBluronBlurAsync 事件。


onChange?

ts
optional onChange: TOnChange;
optional onChange: TOnChange;

定义于: packages/form-core/src/FieldApi.ts:299

一个可选函数,在输入的更改事件上运行。

示例

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

onChangeAsync?

ts
optional onChangeAsync: TOnChangeAsync;
optional onChangeAsync: TOnChangeAsync;

定义于: packages/form-core/src/FieldApi.ts:305

一个可选属性,类似于 onChange,但用于异步校验。

示例

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

onChangeAsyncDebounceMs?

ts
optional onChangeAsyncDebounceMs: number;
optional onChangeAsyncDebounceMs: number;

定义于: packages/form-core/src/FieldApi.ts:311

一个可选数字,表示 onChangeAsync 在运行前应等待多长时间。

如果设置为大于 0 的数字,将按此毫秒长度对异步校验事件进行防抖处理。


onChangeListenTo?

ts
optional onChangeListenTo: DeepKeys<TParentData>[];
optional onChangeListenTo: DeepKeys<TParentData>[];

定义于: packages/form-core/src/FieldApi.ts:315

一个可选的字段名称列表,当其值更改时,应触发此字段的 onChangeonChangeAsync 事件。


onMount?

ts
optional onMount: TOnMount;
optional onMount: TOnMount;

定义于: packages/form-core/src/FieldApi.ts:293

一个可选函数,在输入的挂载事件上运行。


onSubmit?

ts
optional onSubmit: TOnSubmit;
optional onSubmit: TOnSubmit;

定义于: packages/form-core/src/FieldApi.ts:344

一个可选函数,在表单的提交事件上运行。

示例

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

onSubmitAsync?

ts
optional onSubmitAsync: TOnSubmitAsync;
optional onSubmitAsync: TOnSubmitAsync;

定义于: packages/form-core/src/FieldApi.ts:350

一个可选属性,类似于 onSubmit,但用于异步校验。

示例

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