FieldApiOptions

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

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

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

继承自

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

类型参数

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>

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>

TFormOnServer 继承自 undefined | FormAsyncValidateOrFn<TParentData>

TParentSubmitMeta

属性

asyncAlways?

ts
optional asyncAlways: boolean;
optional asyncAlways: boolean;

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

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

继承自

FieldOptions.asyncAlways


asyncDebounceMs?

ts
optional asyncDebounceMs: number;
optional asyncDebounceMs: number;

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

如果没有传递更具体的去抖时间,则异步验证的默认去抖时间。

继承自

FieldOptions.asyncDebounceMs


defaultMeta?

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

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

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

继承自

FieldOptions.defaultMeta


defaultValue?

ts
optional defaultValue: NoInfer<TData>;
optional defaultValue: NoInfer<TData>;

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

字段的可选默认值。

继承自

FieldOptions.defaultValue


disableErrorFlat?

ts
optional disableErrorFlat: boolean;
optional disableErrorFlat: boolean;

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

禁用 field.errors 上的 flat(1) 操作。如果您想保持错误结构不变,这将很有用。不建议在大多数用例中使用。

继承自

FieldOptions.disableErrorFlat


form

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

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


listeners?

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

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

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

继承自

FieldOptions.listeners


name

ts
name: TName;
name: TName;

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

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

继承自

FieldOptions.name


validators?

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

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

要传递给字段的验证器列表

继承自

FieldOptions.validators

订阅 Bytes

您的每周 JavaScript 新闻。每周一免费发送给超过 10 万名开发者。

Bytes

没有垃圾邮件。随时取消订阅。