unknown[] | Promise<unknown[]>定义于: packages/form-core/src/FieldApi.ts:863
表示用于管理表单字段的 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<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:995
初始化一个新的 FieldApi 实例。
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: 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:907
对表单 API 实例的引用。
name: DeepKeys<TParentData>;
name: DeepKeys<TParentData>;
定义于: packages/form-core/src/FieldApi.ts:931
字段名称。
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:935
字段选项。
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:959
字段状态存储。
timeoutIds: object;
timeoutIds: object;
定义于: packages/form-core/src/FieldApi.ts:986
formListeners: Record<ListenerCause, null | Timeout>;
formListeners: Record<ListenerCause, null | Timeout>;
listeners: Record<ListenerCause, null | Timeout>;
listeners: Record<ListenerCause, null | Timeout>;
validations: Record<ValidationCause, null | Timeout>;
validations: Record<ValidationCause, null | Timeout>;
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:983
当前字段状态。
FieldState<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync>
clearValues(opts?): void
clearValues(opts?): void
定义于: packages/form-core/src/FieldApi.ts:1319
清除数组中的所有值。
UpdateMetaOptions
void
getInfo(): FieldInfo<TParentData>
getInfo(): FieldInfo<TParentData>
定义于: packages/form-core/src/FieldApi.ts:1249
获取字段信息对象。
FieldInfo<TParentData>
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:1217
FieldMeta<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync>
getValue(): TData
getValue(): TData
定义于: packages/form-core/src/FieldApi.ts:1202
获取当前字段值。
TData
请改用 field.state.value。
handleBlur(): void
handleBlur(): void
定义于: packages/form-core/src/FieldApi.ts:1670
处理失焦事件。
void
handleChange(updater): void
handleChange(updater): void
定义于: packages/form-core/src/FieldApi.ts:1663
处理更改事件。
Updater<TData>
void
insertValue(
index,
value,
opts?): void
insertValue(
index,
value,
opts?): void
定义于: packages/form-core/src/FieldApi.ts:1266
在指定索引处插入一个值，并将后续值向右移动。
number
TData extends any[] ? TData<TData>[number] : never
UpdateMetaOptions
void
mount(): () => void
mount(): () => void
定义于: packages/form-core/src/FieldApi.ts:1092
将字段实例挂载到表单。
Function
void
moveValue(
aIndex,
bIndex,
opts?): void
moveValue(
aIndex,
bIndex,
opts?): void
定义于: packages/form-core/src/FieldApi.ts:1310
将第一个指定索引处的值移动到第二个指定索引处。
number
number
UpdateMetaOptions
void
parseValueWithSchema(schema):
| undefined
| StandardSchemaV1Issue[]
parseValueWithSchema(schema):
| undefined
| StandardSchemaV1Issue[]
定义于: packages/form-core/src/FieldApi.ts:1711
使用给定的模式解析字段的值并返回问题（如果有）。此方法不会设置任何内部错误。
StandardSchemaV1<TData, unknown>
用于解析此字段值的标准模式。
| undefined | StandardSchemaV1Issue[]
parseValueWithSchemaAsync(schema): Promise<
| undefined
| StandardSchemaV1Issue[]>
parseValueWithSchemaAsync(schema): Promise<
| undefined
| StandardSchemaV1Issue[]>
定义于: packages/form-core/src/FieldApi.ts:1723
使用给定的模式异步解析字段的值并返回问题（如果有）。此方法不会设置任何内部错误。
StandardSchemaV1<TData, unknown>
用于解析此字段值的标准模式。
Promise< | undefined | StandardSchemaV1Issue[]>
pushValue(value, opts?): void
pushValue(value, opts?): void
定义于: packages/form-core/src/FieldApi.ts:1254
向字段推送一个新值。
TData extends any[] ? TData<TData>[number] : never
UpdateMetaOptions
void
removeValue(index, opts?): void
removeValue(index, opts?): void
定义于: packages/form-core/src/FieldApi.ts:1292
删除指定索引处的值。
number
UpdateMetaOptions
void
replaceValue(
index,
value,
opts?): void
replaceValue(
index,
value,
opts?): void
定义于: packages/form-core/src/FieldApi.ts:1279
替换指定索引处的值。
number
TData extends any[] ? TData<TData>[number] : never
UpdateMetaOptions
void
setErrorMap(errorMap): void
setErrorMap(errorMap): void
定义于: packages/form-core/src/FieldApi.ts:1686
更新字段的 errorMap。
ValidationErrorMap<UnwrapFieldValidateOrFn<TName, TOnMount, TFormOnMount>, UnwrapFieldValidateOrFn<TName, TOnChange, TFormOnChange>, UnwrapFieldAsyncValidateOrFn<TName, TOnChangeAsync, TFormOnChangeAsync>, UnwrapFieldValidateOrFn<TName, TOnBlur, TFormOnBlur>, UnwrapFieldAsyncValidateOrFn<TName, TOnBlurAsync, TFormOnBlurAsync>, UnwrapFieldValidateOrFn<TName, TOnSubmit, TFormOnSubmit>, UnwrapFieldAsyncValidateOrFn<TName, TOnSubmitAsync, TFormOnSubmitAsync>>
void
setMeta(updater): void
setMeta(updater): void
定义于: packages/form-core/src/FieldApi.ts:1222
设置字段元数据。
Updater<FieldMetaBase<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync>>
void
setValue(updater, options?): void
setValue(updater, options?): void
定义于: packages/form-core/src/FieldApi.ts:1209
设置字段值并运行 change 校验器。
Updater<TData>
UpdateMetaOptions
void
swapValues(
aIndex,
bIndex,
opts?): void
swapValues(
aIndex,
bIndex,
opts?): void
定义于: packages/form-core/src/FieldApi.ts:1301
交换指定索引处的值。
number
number
UpdateMetaOptions
void
update(opts): void
update(opts): void
定义于: packages/form-core/src/FieldApi.ts:1145
使用新选项更新字段实例。
FieldApiOptions<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer, TParentSubmitMeta>
void
validate(cause, opts?): unknown[] | Promise<unknown[]>
validate(cause, opts?): unknown[] | Promise<unknown[]>
定义于: packages/form-core/src/FieldApi.ts:1630
校验字段值。
ValidationCause
boolean