Class: FormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>

Defined in: packages/form-core/src/FormApi.ts:885

A class representing the Form API. It handles the logic and interactions with the form state.

Normally, you will not need to create a new FormApi instance directly. Instead, you will use a framework hook/function like useForm or createForm 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 FormApi constructor.

Type Parameters

• TFormData

• TOnMount extends undefined | FormValidateOrFn<TFormData>

• TOnChange extends undefined | FormValidateOrFn<TFormData>

• TOnChangeAsync extends undefined | FormAsyncValidateOrFn<TFormData>

• TOnBlur extends undefined | FormValidateOrFn<TFormData>

• TOnBlurAsync extends undefined | FormAsyncValidateOrFn<TFormData>

• TOnSubmit extends undefined | FormValidateOrFn<TFormData>

• TOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFormData>

• TOnDynamic extends undefined | FormValidateOrFn<TFormData>

• TOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TFormData>

• TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>

• TSubmitMeta = never

Implements

FieldManipulator<TFormData, TSubmitMeta>

Constructors

new FormApi()

new FormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>(opts?): FormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>

new FormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>(opts?): FormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>

Defined in: packages/form-core/src/FormApi.ts:982

Constructs a new FormApi instance with the given form options.

Parameters

opts?

FormOptions<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>

Returns

FormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>

Properties

baseStore

baseStore: Store<BaseFormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer>>;

baseStore: Store<BaseFormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer>>;

Defined in: packages/form-core/src/FormApi.ts:917

fieldInfo

fieldInfo: Record<DeepKeys<TFormData>, FieldInfo<TFormData>>;

fieldInfo: Record<DeepKeys<TFormData>, FieldInfo<TFormData>>;

Defined in: packages/form-core/src/FormApi.ts:951

A record of field information for each field in the form.

fieldMetaDerived

fieldMetaDerived: Derived<Record<DeepKeys<TFormData>, AnyFieldMeta>>;

fieldMetaDerived: Derived<Record<DeepKeys<TFormData>, AnyFieldMeta>>;

Defined in: packages/form-core/src/FormApi.ts:932

options

options: FormOptions<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta> = {};

options: FormOptions<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta> = {};

Defined in: packages/form-core/src/FormApi.ts:903

The options for the form.

store

store: Derived<FormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer>>;

store: Derived<FormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer>>;

Defined in: packages/form-core/src/FormApi.ts:933

Accessors

formId

Get Signature

get formId(): string

get formId(): string

Defined in: packages/form-core/src/FormApi.ts:1333

Returns

string

state

Get Signature

get state(): FormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer>

get state(): FormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer>

Defined in: packages/form-core/src/FormApi.ts:953

Returns

FormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer>

Methods

clearFieldValues()

clearFieldValues<TField>(field, options?): void

clearFieldValues<TField>(field, options?): void

Defined in: packages/form-core/src/FormApi.ts:2437

Clear all values within an array field.

Type Parameters

• TField extends string

Parameters

field

TField

options?

UpdateMetaOptions

Returns

void

Implementation of

FieldManipulator.clearFieldValues

FieldManipulator.clearFieldValues

deleteField()

deleteField<TField>(field): void

deleteField<TField>(field): void

Defined in: packages/form-core/src/FormApi.ts:2246

Type Parameters

• TField extends string

Parameters

field

TField

Returns

void

Implementation of

FieldManipulator.deleteField

FieldManipulator.deleteField

getAllErrors()

getAllErrors(): object

getAllErrors(): object

Defined in: packages/form-core/src/FormApi.ts:2549

Returns form and field level errors

Returns

object

fields

fields: Record<DeepKeys<TFormData>, {
  errorMap: ValidationErrorMap;
  errors: unknown[];
}>;

fields: Record<DeepKeys<TFormData>, {
  errorMap: ValidationErrorMap;
  errors: unknown[];
}>;

form

form: object;

form: object;

form.errorMap

errorMap: ValidationErrorMap<UnwrapFormValidateOrFn<TOnMount>, UnwrapFormValidateOrFn<TOnChange>, UnwrapFormAsyncValidateOrFn<TOnChangeAsync>, UnwrapFormValidateOrFn<TOnBlur>, UnwrapFormAsyncValidateOrFn<TOnBlurAsync>, UnwrapFormValidateOrFn<TOnSubmit>, UnwrapFormAsyncValidateOrFn<TOnSubmitAsync>, UnwrapFormValidateOrFn<TOnDynamic>, UnwrapFormAsyncValidateOrFn<TOnDynamicAsync>, UnwrapFormAsyncValidateOrFn<TOnServer>>;

errorMap: ValidationErrorMap<UnwrapFormValidateOrFn<TOnMount>, UnwrapFormValidateOrFn<TOnChange>, UnwrapFormAsyncValidateOrFn<TOnChangeAsync>, UnwrapFormValidateOrFn<TOnBlur>, UnwrapFormAsyncValidateOrFn<TOnBlurAsync>, UnwrapFormValidateOrFn<TOnSubmit>, UnwrapFormAsyncValidateOrFn<TOnSubmitAsync>, UnwrapFormValidateOrFn<TOnDynamic>, UnwrapFormAsyncValidateOrFn<TOnDynamicAsync>, UnwrapFormAsyncValidateOrFn<TOnServer>>;

form.errors

errors: (
  | UnwrapFormValidateOrFn<TOnMount>
  | UnwrapFormValidateOrFn<TOnChange>
  | UnwrapFormAsyncValidateOrFn<TOnChangeAsync>
  | UnwrapFormValidateOrFn<TOnBlur>
  | UnwrapFormAsyncValidateOrFn<TOnBlurAsync>
  | UnwrapFormValidateOrFn<TOnSubmit>
  | UnwrapFormAsyncValidateOrFn<TOnSubmitAsync>
  | UnwrapFormValidateOrFn<TOnDynamic>
  | UnwrapFormAsyncValidateOrFn<TOnDynamicAsync>
  | UnwrapFormAsyncValidateOrFn<TOnServer>)[];

errors: (
  | UnwrapFormValidateOrFn<TOnMount>
  | UnwrapFormValidateOrFn<TOnChange>
  | UnwrapFormAsyncValidateOrFn<TOnChangeAsync>
  | UnwrapFormValidateOrFn<TOnBlur>
  | UnwrapFormAsyncValidateOrFn<TOnBlurAsync>
  | UnwrapFormValidateOrFn<TOnSubmit>
  | UnwrapFormAsyncValidateOrFn<TOnSubmitAsync>
  | UnwrapFormValidateOrFn<TOnDynamic>
  | UnwrapFormAsyncValidateOrFn<TOnDynamicAsync>
  | UnwrapFormAsyncValidateOrFn<TOnServer>)[];

getFieldInfo()

getFieldInfo<TField>(field): FieldInfo<TFormData>

getFieldInfo<TField>(field): FieldInfo<TFormData>

Defined in: packages/form-core/src/FormApi.ts:2149

Gets the field info of the specified field.

Type Parameters

• TField extends string

Parameters

field

TField

Returns

FieldInfo<TFormData>

getFieldMeta()

getFieldMeta<TField>(field): undefined | AnyFieldMeta

getFieldMeta<TField>(field): undefined | AnyFieldMeta

Defined in: packages/form-core/src/FormApi.ts:2140

Gets the metadata of the specified field.

Type Parameters

• TField extends string

Parameters

field

TField

Returns

undefined | AnyFieldMeta

Implementation of

FieldManipulator.getFieldMeta

FieldManipulator.getFieldMeta

getFieldValue()

getFieldValue<TField>(field): DeepValue<TFormData, TField>

getFieldValue<TField>(field): DeepValue<TFormData, TField>

Defined in: packages/form-core/src/FormApi.ts:2133

Gets the value of the specified field.

Type Parameters

• TField extends string

Parameters

field

TField

Returns

DeepValue<TFormData, TField>

Implementation of

FieldManipulator.getFieldValue

FieldManipulator.getFieldValue

handleSubmit()

Call Signature

handleSubmit(): Promise<void>

handleSubmit(): Promise<void>

Defined in: packages/form-core/src/FormApi.ts:1992

Handles the form submission, performs validation, and calls the appropriate onSubmit or onSubmitInvalid callbacks.

Returns

Promise<void>

Implementation of

FieldManipulator.handleSubmit

FieldManipulator.handleSubmit

Call Signature

handleSubmit(submitMeta): Promise<void>

handleSubmit(submitMeta): Promise<void>

Defined in: packages/form-core/src/FormApi.ts:1993

Handles the form submission, performs validation, and calls the appropriate onSubmit or onSubmitInvalid callbacks.

Parameters

submitMeta

TSubmitMeta

Returns

Promise<void>

Implementation of

FieldManipulator.handleSubmit

FieldManipulator.handleSubmit

insertFieldValue()

insertFieldValue<TField>(
   field, 
   index, 
   value, 
options?): Promise<void>

insertFieldValue<TField>(
   field, 
   index, 
   value, 
options?): Promise<void>

Defined in: packages/form-core/src/FormApi.ts:2284

Type Parameters

• TField extends string

Parameters

field

TField

index

number

value

DeepValue<TFormData, TField> extends any[] ? any[] & DeepValue<TFormData, TField>[number] : never

options?

UpdateMetaOptions

Returns

Promise<void>

Implementation of

FieldManipulator.insertFieldValue

FieldManipulator.insertFieldValue

mount()

mount(): () => void

mount(): () => void

Defined in: packages/form-core/src/FormApi.ts:1362

Returns

Function

Returns

void

moveFieldValues()

moveFieldValues<TField>(
   field, 
   index1, 
   index2, 
   options?): void

moveFieldValues<TField>(
   field, 
   index1, 
   index2, 
   options?): void

Defined in: packages/form-core/src/FormApi.ts:2408

Moves the value at the first specified index to the second specified index within an array field.

Type Parameters

• TField extends string

Parameters

field

TField

index1

number

index2

number

options?

UpdateMetaOptions

Returns

void

Implementation of

FieldManipulator.moveFieldValues

FieldManipulator.moveFieldValues

parseValuesWithSchema()

parseValuesWithSchema(schema): 
  | undefined
  | {
  fields: Record<string, StandardSchemaV1Issue[]>;
  form: Record<string, StandardSchemaV1Issue[]>;
}

parseValuesWithSchema(schema): 
  | undefined
  | {
  fields: Record<string, StandardSchemaV1Issue[]>;
  form: Record<string, StandardSchemaV1Issue[]>;
}

Defined in: packages/form-core/src/FormApi.ts:2613

Parses the form's values with a given standard schema and returns issues (if any). This method does NOT set any internal errors.

Parameters

schema

StandardSchemaV1<TFormData, unknown>

The standard schema to parse the form values with.

Returns

| undefined | { fields: Record<string, StandardSchemaV1Issue[]>; form: Record<string, StandardSchemaV1Issue[]>; }

parseValuesWithSchemaAsync()

parseValuesWithSchemaAsync(schema): Promise<
  | undefined
  | {
  fields: Record<string, StandardSchemaV1Issue[]>;
  form: Record<string, StandardSchemaV1Issue[]>;
}>

parseValuesWithSchemaAsync(schema): Promise<
  | undefined
  | {
  fields: Record<string, StandardSchemaV1Issue[]>;
  form: Record<string, StandardSchemaV1Issue[]>;
}>

Defined in: packages/form-core/src/FormApi.ts:2625

Parses the form's values with a given standard schema and returns issues (if any). This method does NOT set any internal errors.

Parameters

schema

StandardSchemaV1<TFormData, unknown>

The standard schema to parse the form values with.

Returns

Promise< | undefined | { fields: Record<string, StandardSchemaV1Issue[]>; form: Record<string, StandardSchemaV1Issue[]>; }>

pushFieldValue()

pushFieldValue<TField>(
   field, 
   value, 
   options?): void

pushFieldValue<TField>(
   field, 
   value, 
   options?): void

Defined in: packages/form-core/src/FormApi.ts:2270

Pushes a value into an array field.

Type Parameters

• TField extends string

Parameters

field

TField

value

DeepValue<TFormData, TField> extends any[] ? any[] & DeepValue<TFormData, TField>[number] : never

options?

UpdateMetaOptions

Returns

void

Implementation of

FieldManipulator.pushFieldValue

FieldManipulator.pushFieldValue

removeFieldValue()

removeFieldValue<TField>(
   field, 
   index, 
options?): Promise<void>

removeFieldValue<TField>(
   field, 
   index, 
options?): Promise<void>

Defined in: packages/form-core/src/FormApi.ts:2342

Removes a value from an array field at the specified index.

Type Parameters

• TField extends string

Parameters

field

TField

index

number

options?

UpdateMetaOptions

Returns

Promise<void>

Implementation of

FieldManipulator.removeFieldValue

FieldManipulator.removeFieldValue

replaceFieldValue()

replaceFieldValue<TField>(
   field, 
   index, 
   value, 
options?): Promise<void>

replaceFieldValue<TField>(
   field, 
   index, 
   value, 
options?): Promise<void>

Defined in: packages/form-core/src/FormApi.ts:2316

Replaces a value into an array field at the specified index.

Type Parameters

• TField extends string

Parameters

field

TField

index

number

value

DeepValue<TFormData, TField> extends any[] ? any[] & DeepValue<TFormData, TField>[number] : never

options?

UpdateMetaOptions

Returns

Promise<void>

Implementation of

FieldManipulator.replaceFieldValue

FieldManipulator.replaceFieldValue

reset()

reset(values?, opts?): void

reset(values?, opts?): void

Defined in: packages/form-core/src/FormApi.ts:1467

Resets the form state to the default values. If values are provided, the form will be reset to those values instead and the default values will be updated.

Parameters

values?

TFormData

Optional values to reset the form to.

opts?

Optional options to control the reset behavior.

keepDefaultValues?

boolean

Returns

void

resetField()

resetField<TField>(field): void

resetField<TField>(field): void

Defined in: packages/form-core/src/FormApi.ts:2467

Resets the field value and meta to default state

Type Parameters

• TField extends string

Parameters

field

TField

Returns

void

Implementation of

FieldManipulator.resetField

FieldManipulator.resetField

resetFieldMeta()

resetFieldMeta<TField>(fieldMeta): Record<TField, AnyFieldMeta>

resetFieldMeta<TField>(fieldMeta): Record<TField, AnyFieldMeta>

Defined in: packages/form-core/src/FormApi.ts:2190

resets every field's meta

Type Parameters

• TField extends string

Parameters

fieldMeta

Record<TField, AnyFieldMeta>

Returns

Record<TField, AnyFieldMeta>

setErrorMap()

setErrorMap(errorMap): void

setErrorMap(errorMap): void

Defined in: packages/form-core/src/FormApi.ts:2485

Updates the form's errorMap

Parameters

errorMap

FormValidationErrorMap<TFormData, UnwrapFormValidateOrFn<TOnMount>, UnwrapFormValidateOrFn<TOnChange>, UnwrapFormAsyncValidateOrFn<TOnChangeAsync>, UnwrapFormValidateOrFn<TOnBlur>, UnwrapFormAsyncValidateOrFn<TOnBlurAsync>, UnwrapFormValidateOrFn<TOnSubmit>, UnwrapFormAsyncValidateOrFn<TOnSubmitAsync>, UnwrapFormValidateOrFn<TOnDynamic>, UnwrapFormAsyncValidateOrFn<TOnDynamicAsync>, UnwrapFormAsyncValidateOrFn<TOnServer>>

Returns

void

setFieldMeta()

setFieldMeta<TField>(field, updater): void

setFieldMeta<TField>(field, updater): void

Defined in: packages/form-core/src/FormApi.ts:2169

Updates the metadata of the specified field.

Type Parameters

• TField extends string

Parameters

field

TField

updater

Updater<AnyFieldMetaBase>

Returns

void

Implementation of

FieldManipulator.setFieldMeta

FieldManipulator.setFieldMeta

setFieldValue()

setFieldValue<TField>(
   field, 
   updater, 
   opts?): void

setFieldValue<TField>(
   field, 
   updater, 
   opts?): void

Defined in: packages/form-core/src/FormApi.ts:2206

Sets the value of the specified field and optionally updates the touched state.

Type Parameters

• TField extends string

Parameters

field

TField

updater

Updater<DeepValue<TFormData, TField>>

opts?

UpdateMetaOptions

Returns

void

Implementation of

FieldManipulator.setFieldValue

FieldManipulator.setFieldValue

swapFieldValues()

swapFieldValues<TField>(
   field, 
   index1, 
   index2, 
   options?): void

swapFieldValues<TField>(
   field, 
   index1, 
   index2, 
   options?): void

Defined in: packages/form-core/src/FormApi.ts:2379

Swaps the values at the specified indices within an array field.

Type Parameters

• TField extends string

Parameters

field

TField

index1

number

index2

number

options?

UpdateMetaOptions

Returns

void

Implementation of

FieldManipulator.swapFieldValues

FieldManipulator.swapFieldValues

update()

update(options?): void

update(options?): void

Defined in: packages/form-core/src/FormApi.ts:1397

Updates the form options and form state.

validateAllFields(cause): Promise<unknown[]>

validateAllFields(cause): Promise<unknown[]>

Defined in: packages/form-core/src/FormApi.ts:1493

Validates all fields using the correct handlers for a given validation cause.

FieldManipulator.validateAllFields

FieldManipulator.validateAllFields

validateArrayFieldsStartingFrom()

validateArrayFieldsStartingFrom<TField>(
   field, 
   index, 
cause): Promise<unknown[]>

validateArrayFieldsStartingFrom<TField>(
   field, 
   index, 
cause): Promise<unknown[]>

Defined in: packages/form-core/src/FormApi.ts:1523

Validates the children of a specified array in the form starting from a given index until the end using the correct handlers for a given validation type.

FieldManipulator.validateArrayFieldsStartingFrom

FieldManipulator.validateArrayFieldsStartingFrom

validateField()

validateField<TField>(field, cause): unknown[] | Promise<unknown[]>

validateField<TField>(field, cause): unknown[] | Promise<unknown[]>

Defined in: packages/form-core/src/FormApi.ts:1564

Validates a specified field in the form using the correct handlers for a given validation type.

FieldManipulator.validateField

FieldManipulator.validateField