Defined in: packages/form-core/src/FieldApi.ts:863

A class representing the API for managing a form field.

Normally, you will not need to create a new FieldApi instance directly. Instead, you will use a framework hook/function like useField or createField to create a new instance for you that uses your framework's reactivity model. However, if you need to create a new instance manually, you can do so by calling the new FieldApi constructor.

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

Defined in: packages/form-core/src/FieldApi.ts:995

Initializes a new FieldApi instance.

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

Defined in: packages/form-core/src/FieldApi.ts:907

A reference to the form API instance.

name: DeepKeys<TParentData>;

name: DeepKeys<TParentData>;

Defined in: packages/form-core/src/FieldApi.ts:931

The field name.

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

Defined in: packages/form-core/src/FieldApi.ts:935

The field options.

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

Defined in: packages/form-core/src/FieldApi.ts:959

The field state store.

timeoutIds: object;

timeoutIds: object;

Defined in: 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>

Defined in: packages/form-core/src/FieldApi.ts:983

The current field state.

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

clearValues(opts?): void

clearValues(opts?): void

Defined in: packages/form-core/src/FieldApi.ts:1319

Clear all values from the array.

UpdateMetaOptions

void

getInfo(): FieldInfo<TParentData>

getInfo(): FieldInfo<TParentData>

Defined in: packages/form-core/src/FieldApi.ts:1249

Gets the field information object.

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>

Defined in: 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

Defined in: packages/form-core/src/FieldApi.ts:1202

Gets the current field value.

TData

Use field.state.value instead.

handleBlur(): void

handleBlur(): void

Defined in: packages/form-core/src/FieldApi.ts:1670

Handles the blur event.

void

handleChange(updater): void

handleChange(updater): void

Defined in: packages/form-core/src/FieldApi.ts:1663

Handles the change event.

Updater<TData>

void

insertValue(
   index, 
   value, 
   opts?): void

insertValue(
   index, 
   value, 
   opts?): void

Defined in: packages/form-core/src/FieldApi.ts:1266

Inserts a value at the specified index, shifting the subsequent values to the right.

number

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

UpdateMetaOptions

void

mount(): () => void

mount(): () => void

Defined in: packages/form-core/src/FieldApi.ts:1092

Mounts the field instance to the form.

Function

void

moveValue(
   aIndex, 
   bIndex, 
   opts?): void

moveValue(
   aIndex, 
   bIndex, 
   opts?): void

Defined in: packages/form-core/src/FieldApi.ts:1310

Moves the value at the first specified index to the second specified index.

number

number

UpdateMetaOptions

void

parseValueWithSchema(schema): 
  | undefined
  | StandardSchemaV1Issue[]

parseValueWithSchema(schema): 
  | undefined
  | StandardSchemaV1Issue[]

Defined in: packages/form-core/src/FieldApi.ts:1711

Parses the field's value with the given schema and returns issues (if any). This method does NOT set any internal errors.

StandardSchemaV1<TData, unknown>

The standard schema to parse this field's value with.

| undefined | StandardSchemaV1Issue[]

parseValueWithSchemaAsync(schema): Promise<
  | undefined
| StandardSchemaV1Issue[]>

parseValueWithSchemaAsync(schema): Promise<
  | undefined
| StandardSchemaV1Issue[]>

Defined in: packages/form-core/src/FieldApi.ts:1723

Parses the field's value with the given schema and returns issues (if any). This method does NOT set any internal errors.

StandardSchemaV1<TData, unknown>

The standard schema to parse this field's value with.

Promise< | undefined | StandardSchemaV1Issue[]>

pushValue(value, opts?): void

pushValue(value, opts?): void

Defined in: packages/form-core/src/FieldApi.ts:1254

Pushes a new value to the field.

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

UpdateMetaOptions

void

removeValue(index, opts?): void

removeValue(index, opts?): void

Defined in: packages/form-core/src/FieldApi.ts:1292

Removes a value at the specified index.

number

UpdateMetaOptions

void

replaceValue(
   index, 
   value, 
   opts?): void

replaceValue(
   index, 
   value, 
   opts?): void

Defined in: packages/form-core/src/FieldApi.ts:1279

Replaces a value at the specified index.

number

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

UpdateMetaOptions

void

setErrorMap(errorMap): void

setErrorMap(errorMap): void

Defined in: packages/form-core/src/FieldApi.ts:1686

Updates the field's 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

Defined in: packages/form-core/src/FieldApi.ts:1222

Sets the field metadata.

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

Defined in: packages/form-core/src/FieldApi.ts:1209

Sets the field value and run the change validator.

Updater<TData>

UpdateMetaOptions

void

swapValues(
   aIndex, 
   bIndex, 
   opts?): void

swapValues(
   aIndex, 
   bIndex, 
   opts?): void

Defined in: packages/form-core/src/FieldApi.ts:1301

Swaps the values at the specified indices.

number

number

UpdateMetaOptions

void

update(opts): void

update(opts): void

Defined in: packages/form-core/src/FieldApi.ts:1145

Updates the field instance with new options.

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[]>

Defined in: packages/form-core/src/FieldApi.ts:1630

Validates the field value.

ValidationCause

boolean

unknown[] | Promise<unknown[]>