TanStackForm v1
自动
框架
版本
菜单
开始使用
指南
API 参考
社区资源
示例

FieldApi

类: FieldApi<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:860

一个类，表示用于管理表单字段的 API。

通常，你不需要直接创建一个新的 FieldApi 实例。相反，你将使用框架钩子/函数，如 useField 或 createField 来为你创建一个新的实例，该实例使用你框架的响应式模型。但是，如果你需要手动创建一个新实例，你可以通过调用 new FieldApi 构造函数来完成。

类型参数

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

• TParentSubmitMeta

构造函数

new FieldApi()

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

new FieldApi<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer, TParentSubmitMeta>(opts): FieldApi<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:974

初始化一个新的 FieldApi 实例。

参数
opts

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

返回值

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

属性

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:890

指向表单 API 实例的引用。

name
ts
name: unknown extends TParentData ? string : TParentData extends readonly any[] & IsTuple<TParentData> ? PrefixTupleAccessor<TParentData<TParentData>, AllowedIndexes<TParentData<TParentData>, never>, []> : TParentData extends any[] ? PrefixArrayAccessor<TParentData<TParentData>, [any]> : TParentData extends Date ? never : TParentData extends object ? PrefixObjectAccessor<TParentData<TParentData>, []> : TParentData extends string | number | bigint | boolean ? "" : never;

name: unknown extends TParentData ? string : TParentData extends readonly any[] & IsTuple<TParentData> ? PrefixTupleAccessor<TParentData<TParentData>, AllowedIndexes<TParentData<TParentData>, never>, []> : TParentData extends any[] ? PrefixArrayAccessor<TParentData<TParentData>, [any]> : TParentData extends Date ? never : TParentData extends object ? PrefixObjectAccessor<TParentData<TParentData>, []> : TParentData extends string | number | bigint | boolean ? "" : never;

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

字段名称。

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

options: 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:918

字段选项。

store
ts
store: Derived<FieldState<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync>>;

store: Derived<FieldState<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync>>;

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

字段状态存储。

timeoutIds
ts
timeoutIds: Record<ValidationCause, null | Timeout>;

timeoutIds: Record<ValidationCause, null | Timeout>;

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

访问器

state

Get Signature

ts
get state(): FieldState<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync>

get state(): FieldState<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync>

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

当前字段状态。

返回值

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

方法

getInfo()

ts
getInfo(): FieldInfo<TParentData>

getInfo(): FieldInfo<TParentData>

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

获取字段信息对象。

返回值

FieldInfo<TParentData>

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

getMeta(): FieldMeta<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync>

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

返回值

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

getValue()
ts
getValue(): TData

getValue(): TData

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

获取当前字段值。

返回值

TData

已弃用

请使用 field.state.value 代替。

handleBlur()
ts
handleBlur(): void

handleBlur(): void

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

处理失焦事件。

返回值

void

handleChange()
ts
handleChange(updater): void

handleChange(updater): void

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

处理更改事件。

参数
updater

Updater<TData>

返回值

void

insertValue()
ts
insertValue(
   index, 
   value, 
   opts?): void

insertValue(
   index, 
   value, 
   opts?): void

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

在指定索引处插入一个值，并将后续值向右移动。

参数
index

number

value

TData extends any[] ? TData<TData>[number] : never

opts?

UpdateMetaOptions

返回值

void

mount()
ts
mount(): () => void

mount(): () => void

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

将字段实例挂载到表单。

返回值

Function

返回值

void

moveValue()
ts
moveValue(
   aIndex, 
   bIndex, 
   opts?): void

moveValue(
   aIndex, 
   bIndex, 
   opts?): void

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

将第一个指定索引处的值移动到第二个指定索引处。

参数
aIndex

number

bIndex

number

opts?

UpdateMetaOptions

返回值

void

pushValue()
ts
pushValue(value, opts?): void

pushValue(value, opts?): void

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

向字段推送一个新值。

参数
value

TData extends any[] ? TData<TData>[number] : never

opts?

UpdateMetaOptions

返回值

void

removeValue()
ts
removeValue(index, opts?): void

removeValue(index, opts?): void

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

移除指定索引处的值。

参数
index

number

opts?

UpdateMetaOptions

返回值

void

replaceValue()
ts
replaceValue(
   index, 
   value, 
   opts?): void

replaceValue(
   index, 
   value, 
   opts?): void

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

替换指定索引处的值。

参数
index

number

value

TData extends any[] ? TData<TData>[number] : never

opts?

UpdateMetaOptions

返回值

void

setErrorMap()
ts
setErrorMap(errorMap): void

setErrorMap(errorMap): void

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

更新字段的 errorMap

参数
errorMap

ValidationErrorMap

返回值

void

setMeta()
ts
setMeta(updater): void

setMeta(updater): void

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

设置字段元数据。

参数
updater

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

返回值

void

setValue()
ts
setValue(updater, options?): void

setValue(updater, options?): void

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

设置字段值并运行 change 验证器。

参数
updater

Updater<TData>

options?

UpdateMetaOptions

返回值

void

swapValues()
ts
swapValues(
   aIndex, 
   bIndex, 
   opts?): void

swapValues(
   aIndex, 
   bIndex, 
   opts?): void

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

交换指定索引处的值。

参数
aIndex

number

bIndex

number

opts?

UpdateMetaOptions

返回值

void

update()
ts
update(opts): void

update(opts): void

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

使用新选项更新字段实例。

参数
opts

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

返回值

void

validate()
ts
validate(cause, opts?): unknown[] | Promise<unknown[]>

validate(cause, opts?): unknown[] | Promise<unknown[]>

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

验证字段值。

参数
cause

ValidationCause

opts?
skipFormValidation?

boolean

返回值

unknown[] | Promise<unknown[]>

在 GitHub 上编辑
JavaScript 参考
类 / FormApi
订阅 Bytes

您的每周 JavaScript 新闻。每周一免费发送给超过 100,000 名开发者。

Bytes

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