接口: FieldApiOptions<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta>

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

表示 FieldApi 类所需选项的对象类型。

继承自

FieldOptions<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync>

类型参数

• TParentData

• TName 扩展自 DeepKeys<TParentData>

• TData 扩展自 DeepValue<TParentData, TName>

• TOnMount 扩展自 undefined | FieldValidateOrFn<TParentData, TName, TData>

• TOnChange 扩展自 undefined | FieldValidateOrFn<TParentData, TName, TData>

• TOnChangeAsync 扩展自 undefined | FieldAsyncValidateOrFn<TParentData, TName, TData>

• TOnBlur 扩展自 undefined | FieldValidateOrFn<TParentData, TName, TData>

• TOnBlurAsync 扩展自 undefined | FieldAsyncValidateOrFn<TParentData, TName, TData>

• TOnSubmit 扩展自 undefined | FieldValidateOrFn<TParentData, TName, TData>

• TOnSubmitAsync 扩展自 undefined | FieldAsyncValidateOrFn<TParentData, TName, TData>

• TOnDynamic 扩展自 undefined | FieldValidateOrFn<TParentData, TName, TData>

• TOnDynamicAsync 扩展自 undefined | FieldAsyncValidateOrFn<TParentData, TName, TData>

• TFormOnMount 扩展自 undefined | FormValidateOrFn<TParentData>

• TFormOnChange 扩展自 undefined | FormValidateOrFn<TParentData>

• TFormOnChangeAsync 扩展自 undefined | FormAsyncValidateOrFn<TParentData>

• TFormOnBlur 扩展自 undefined | FormValidateOrFn<TParentData>

• TFormOnBlurAsync 扩展自 undefined | FormAsyncValidateOrFn<TParentData>

• TFormOnSubmit 扩展自 undefined | FormValidateOrFn<TParentData>

• TFormOnSubmitAsync 扩展自 undefined | FormAsyncValidateOrFn<TParentData>

• TFormOnDynamic 扩展自 undefined | FormValidateOrFn<TParentData>

• TFormOnDynamicAsync 扩展自 undefined | FormAsyncValidateOrFn<TParentData>

• TFormOnServer 扩展自 undefined | FormAsyncValidateOrFn<TParentData>

• TParentSubmitMeta

属性

asyncAlways?

optional asyncAlways: boolean;

optional asyncAlways: boolean;

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

如果为 true，则始终运行异步验证，即使同步验证期间有错误发出。

继承自

FieldOptions.asyncAlways

asyncDebounceMs?

optional asyncDebounceMs: number;

optional asyncDebounceMs: number;

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

异步验证的默认去抖动时间（毫秒），如果没有指定更具体的去抖动时间。

继承自

FieldOptions.asyncDebounceMs

defaultMeta?

optional defaultMeta: Partial<FieldMeta<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, any, any, any, any, any, any, any, any, any>>;

optional defaultMeta: Partial<FieldMeta<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, any, any, any, any, any, any, any, any, any>>;

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

字段的默认元数据对象（可选）。

继承自

FieldOptions.defaultMeta

defaultValue?

optional defaultValue: NoInfer<TData>;

optional defaultValue: NoInfer<TData>;

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

字段的可选默认值。

继承自

FieldOptions.defaultValue

disableErrorFlat?

optional disableErrorFlat: boolean;

optional disableErrorFlat: boolean;

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

禁用对 field.errors 的 flat(1) 操作。如果您想保留错误结构的原始形式，这非常有用。不建议大多数用例使用。

继承自

FieldOptions.disableErrorFlat

form

form: FormApi<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta>;

form: FormApi<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta>;

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

listeners?

optional listeners: FieldListeners<TParentData, TName, TData>;

optional listeners: FieldListeners<TParentData, TName, TData>;

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

附加到相应事件的监听器列表

继承自

FieldOptions.listeners

name

name: TName;

name: TName;

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

字段名称。类型将是 DeepKeys<TParentData>，以确保您的名称是父数据集的深层键。

继承自

FieldOptions.name

validators?

optional validators: FieldValidators<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync>;

optional validators: FieldValidators<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync>;

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

传递给字段的验证器列表