FieldOptions

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

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

表示表单字段选项的对象类型。

继承自

类型参数

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>

属性

asyncAlways?

ts
optional asyncAlways: boolean;
optional asyncAlways: boolean;

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

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


asyncDebounceMs?

ts
optional asyncDebounceMs: number;
optional asyncDebounceMs: number;

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

如果未指定更具体的 debounce 时间,则用于 debounce 异步验证的默认时间。


defaultMeta?

ts
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

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


defaultValue?

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

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

字段的可选默认值。


disableErrorFlat?

ts
optional disableErrorFlat: boolean;
optional disableErrorFlat: boolean;

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

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


listeners?

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

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

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


name

ts
name: TName;
name: TName;

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

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


validators?

ts
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

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

我们的合作伙伴
Code Rabbit
订阅 Bytes

您的每周 JavaScript 资讯。每周一免费发送给超过 10 万开发者。

Bytes

无垃圾邮件。您可以随时取消订阅。

订阅 Bytes

您的每周 JavaScript 资讯。每周一免费发送给超过 10 万开发者。

Bytes

无垃圾邮件。您可以随时取消订阅。