TanStackForm v1
自动
框架
版本
菜单
开始上手
指南
API 参考
示例

TanStackField

类：TanStackField<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer, TSubmitMeta>

定义于： tanstack-field.directive.ts:31

类型参数

• 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>

• TFormOnMount extends undefined | FormValidateOrFn<TParentData>

• TFormOnChange extends undefined | FormValidateOrFn<TParentData>

• TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>

• TFormOnBlur extends undefined | FormValidateOrFn<TParentData>

• TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>

• TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>

• TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>

• TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>

• TSubmitMeta

实现
  • OnInit
  • OnChanges
  • OnDestroy
  • FieldOptions<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync>

构造函数

new TanStackField()

ts
new TanStackField<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer, TSubmitMeta>(): TanStackField<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer, TSubmitMeta>

new TanStackField<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer, TSubmitMeta>(): TanStackField<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer, TSubmitMeta>

返回值

TanStackField<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer, TSubmitMeta>

属性

api

ts
api: FieldApi<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer, TSubmitMeta>;

api: FieldApi<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer, TSubmitMeta>;

定义于： tanstack-field.directive.ts:129

asyncAlways?
ts
optional asyncAlways: boolean;

optional asyncAlways: boolean;

定义于： tanstack-field.directive.ts:78

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

实现自
ts
FieldOptions.asyncAlways

FieldOptions.asyncAlways

asyncDebounceMs?
ts
optional asyncDebounceMs: number;

optional asyncDebounceMs: number;

定义于： tanstack-field.directive.ts:77

如果没有传递更具体的防抖时间，则这是异步验证的默认防抖时间。

实现自
ts
FieldOptions.asyncDebounceMs

FieldOptions.asyncDebounceMs

defaultMeta?
ts
optional defaultMeta: Partial<FieldMeta<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync>>;

optional defaultMeta: Partial<FieldMeta<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync>>;

定义于： tanstack-field.directive.ts:106

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

实现自
ts
FieldOptions.defaultMeta

FieldOptions.defaultMeta

defaultValue?
ts
optional defaultValue: NoInfer<TData>;

optional defaultValue: NoInfer<TData>;

定义于： tanstack-field.directive.ts:76

字段的可选默认值。

实现自
ts
FieldOptions.defaultValue

FieldOptions.defaultValue

disableErrorFlat?
ts
optional disableErrorFlat: boolean;

optional disableErrorFlat: boolean;

定义于： tanstack-field.directive.ts:127

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

实现自
ts
FieldOptions.disableErrorFlat

FieldOptions.disableErrorFlat

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

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

定义于： tanstack-field.directive.ts:105

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

实现自
ts
FieldOptions.listeners

FieldOptions.listeners

name
ts
name: TName;

name: TName;

定义于： tanstack-field.directive.ts:75

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

实现自
ts
FieldOptions.name

FieldOptions.name

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

tanstackField: FormApi<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer, TSubmitMeta>;

定义于： tanstack-field.directive.ts:79

unmount()?
ts
optional unmount: () => void;

optional unmount: () => void;

定义于： tanstack-field.directive.ts:185

返回值

void

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

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

定义于： tanstack-field.directive.ts:91

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

实现自
ts
FieldOptions.validators

FieldOptions.validators

方法

ngOnChanges()

ts
ngOnChanges(): void

ngOnChanges(): void

定义于： tanstack-field.directive.ts:197

一个回调方法，在默认变更检测器检查完数据绑定属性（如果至少有一个已更改）之后立即调用，并在检查视图和内容子项之前调用。

返回值

void

实现自
ts
OnChanges.ngOnChanges

OnChanges.ngOnChanges

ngOnDestroy()
ts
ngOnDestroy(): void

ngOnDestroy(): void

定义于： tanstack-field.directive.ts:193

一个执行自定义清理的回调方法，在指令、管道或服务实例销毁之前立即调用。

返回值

void

实现自
ts
OnDestroy.ngOnDestroy

OnDestroy.ngOnDestroy

ngOnInit()
ts
ngOnInit(): void

ngOnInit(): void

定义于： tanstack-field.directive.ts:187

一个回调方法，在默认变更检测器首次检查完指令的数据绑定属性之后立即调用，并在检查任何视图或内容子项之前调用。 它仅在指令实例化时调用一次。

返回值

void

实现自
ts
OnInit.ngOnInit

OnInit.ngOnInit
在 GitHub 上编辑
Angular 参考
函数 / injectForm
订阅 Bytes 简报

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

Bytes

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