Class: FormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer, TSubmitMeta>#
Defined in: packages/form-core/src/FormApi.ts:771
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>
• TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>
• TSubmitMeta = never
Constructors#
new FormApi()#
new FormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer, TSubmitMeta>(opts?): FormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer, TSubmitMeta>
Defined in: packages/form-core/src/FormApi.ts:842
Constructs a new FormApi instance with the given form options.
Parameters#
opts?#
FormOptions<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer, TSubmitMeta>
Returns#
FormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer, TSubmitMeta>
Properties#
baseStore#
baseStore: Store<BaseFormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer>>;
Defined in: packages/form-core/src/FormApi.ts:798
fieldInfo#
fieldInfo: Record<DeepKeys<TFormData>, FieldInfo<TFormData>>;
Defined in: packages/form-core/src/FormApi.ts:828
A record of field information for each field in the form.
fieldMetaDerived#
fieldMetaDerived: Derived<Record<DeepKeys<TFormData>, AnyFieldMeta>>;
Defined in: packages/form-core/src/FormApi.ts:811
options#
options: FormOptions<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer, TSubmitMeta> = {};
Defined in: packages/form-core/src/FormApi.ts:786
The options for the form.
store#
store: Derived<FormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer>>;
Defined in: packages/form-core/src/FormApi.ts:812
Accessors#
state#
Get Signature#
get state(): FormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer>
Defined in: packages/form-core/src/FormApi.ts:830
Returns#
FormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer>
Methods#
deleteField()#
deleteField<TField>(field): void
Defined in: packages/form-core/src/FormApi.ts:1940
Type Parameters#
• TField extends string
Parameters#
field#
TField
Returns#
void
getAllErrors()#
getAllErrors(): object
Defined in: packages/form-core/src/FormApi.ts:2211
Returns form and field level errors
Returns#
object
fields#
fields: Record<DeepKeys<TFormData>, {
errorMap: ValidationErrorMap;
errors: unknown[];
}>;
form#
form: object;
form.errorMap#
errorMap: ValidationErrorMap<UnwrapFormValidateOrFn<TOnMount>, UnwrapFormValidateOrFn<TOnChange>, UnwrapFormAsyncValidateOrFn<TOnChangeAsync>, UnwrapFormValidateOrFn<TOnBlur>, UnwrapFormAsyncValidateOrFn<TOnBlurAsync>, UnwrapFormValidateOrFn<TOnSubmit>, UnwrapFormAsyncValidateOrFn<TOnSubmitAsync>, UnwrapFormAsyncValidateOrFn<TOnServer>>;
form.errors#
errors: (
| UnwrapFormValidateOrFn<TOnMount>
| UnwrapFormValidateOrFn<TOnChange>
| UnwrapFormAsyncValidateOrFn<TOnChangeAsync>
| UnwrapFormValidateOrFn<TOnBlur>
| UnwrapFormAsyncValidateOrFn<TOnBlurAsync>
| UnwrapFormValidateOrFn<TOnSubmit>
| UnwrapFormAsyncValidateOrFn<TOnSubmitAsync>
| UnwrapFormAsyncValidateOrFn<TOnServer>)[];
getFieldInfo()#
getFieldInfo<TField>(field): FieldInfo<TFormData>
Defined in: packages/form-core/src/FormApi.ts:1854
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
Defined in: packages/form-core/src/FormApi.ts:1845
Gets the metadata of the specified field.
Type Parameters#
• TField extends string
Parameters#
field#
TField
Returns#
undefined | AnyFieldMeta
getFieldValue()#
getFieldValue<TField>(field): DeepValue<TFormData, TField>
Defined in: packages/form-core/src/FormApi.ts:1838
Gets the value of the specified field.
Type Parameters#
• TField extends string
Parameters#
field#
TField
Returns#
DeepValue<TFormData, TField>
handleSubmit()#
Call Signature#
handleSubmit(): Promise<void>
Defined in: packages/form-core/src/FormApi.ts:1740
Handles the form submission, performs validation, and calls the appropriate onSubmit or onSubmitInvalid callbacks.
Returns#
Promise<void>
Call Signature#
handleSubmit(submitMeta): Promise<void>
Defined in: packages/form-core/src/FormApi.ts:1741
Handles the form submission, performs validation, and calls the appropriate onSubmit or onSubmitInvalid callbacks.
Parameters#
submitMeta#
TSubmitMeta
Returns#
Promise<void>
insertFieldValue()#
insertFieldValue<TField>(
field,
index,
value,
opts?): Promise<void>
Defined in: packages/form-core/src/FormApi.ts:1979
Type Parameters#
• TField extends string
Parameters#
field#
TField
index#
number
value#
DeepValue<TFormData, TField> extends any[] ? any[] & DeepValue<TFormData, TField>[number] : never
opts?#
UpdateMetaOptions
Returns#
Promise<void>
mount()#
mount(): () => void
Defined in: packages/form-core/src/FormApi.ts:1168
Returns#
Function
Returns#
void
moveFieldValues()#
moveFieldValues<TField>(
field,
index1,
index2,
opts?): void
Defined in: packages/form-core/src/FormApi.ts:2103
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
opts?#
UpdateMetaOptions
Returns#
void
parseValuesWithSchema()#
parseValuesWithSchema(schema):
| undefined
| {
fields: Record<string, StandardSchemaV1Issue[]>;
form: Record<string, StandardSchemaV1Issue[]>;
}
Defined in: packages/form-core/src/FormApi.ts:2271
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[]>;
}>
Defined in: packages/form-core/src/FormApi.ts:2283
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,
opts?): void
Defined in: packages/form-core/src/FormApi.ts:1964
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
opts?#
UpdateMetaOptions
Returns#
void
removeFieldValue()#
removeFieldValue<TField>(
field,
index,
opts?): Promise<void>
Defined in: packages/form-core/src/FormApi.ts:2037
Removes a value from an array field at the specified index.
Type Parameters#
• TField extends string
Parameters#
field#
TField
index#
number
opts?#
UpdateMetaOptions
Returns#
Promise<void>
replaceFieldValue()#
replaceFieldValue<TField>(
field,
index,
value,
opts?): Promise<void>
Defined in: packages/form-core/src/FormApi.ts:2011
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
opts?#
UpdateMetaOptions
Returns#
Promise<void>
reset()#
reset(values?, opts?): void
Defined in: packages/form-core/src/FormApi.ts:1256
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
Defined in: packages/form-core/src/FormApi.ts:2131
Resets the field value and meta to default state
Type Parameters#
• TField extends string
Parameters#
field#
TField
Returns#
void
resetFieldMeta()#
resetFieldMeta<TField>(fieldMeta): Record<TField, AnyFieldMeta>
Defined in: packages/form-core/src/FormApi.ts:1894
resets every field's meta
Type Parameters#
• TField extends string
Parameters#
fieldMeta#
Record<TField, AnyFieldMeta>
Returns#
Record<TField, AnyFieldMeta>
setErrorMap()#
setErrorMap(errorMap): void
Defined in: packages/form-core/src/FormApi.ts:2149
Updates the form's errorMap
Parameters#
errorMap#
FormValidationErrorMap<TFormData, UnwrapFormValidateOrFn<TOnMount>, UnwrapFormValidateOrFn<TOnChange>, UnwrapFormAsyncValidateOrFn<TOnChangeAsync>, UnwrapFormValidateOrFn<TOnBlur>, UnwrapFormAsyncValidateOrFn<TOnBlurAsync>, UnwrapFormValidateOrFn<TOnSubmit>, UnwrapFormAsyncValidateOrFn<TOnSubmitAsync>, UnwrapFormAsyncValidateOrFn<TOnServer>>
Returns#
void
setFieldMeta()#
setFieldMeta<TField>(field, updater): void
Defined in: packages/form-core/src/FormApi.ts:1873
Updates the metadata of the specified field.
Type Parameters#
• TField extends string
Parameters#
field#
TField
updater#
Returns#
void
setFieldValue()#
setFieldValue<TField>(
field,
updater,
opts?): void
Defined in: packages/form-core/src/FormApi.ts:1910
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
swapFieldValues()#
swapFieldValues<TField>(
field,
index1,
index2,
opts?): void
Defined in: packages/form-core/src/FormApi.ts:2074
Swaps the values at the specified indices within an array field.
Type Parameters#
• TField extends string
Parameters#
field#
TField
index1#
number
index2#
number
opts?#
UpdateMetaOptions
Returns#
void
update()#
update(options?): void
Defined in: packages/form-core/src/FormApi.ts:1188
Updates the form options and form state.
Parameters#
options?#
FormOptions<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer, TSubmitMeta>
Returns#
void
validateAllFields()#
validateAllFields(cause): Promise<unknown[]>
Defined in: packages/form-core/src/FormApi.ts:1282
Validates all fields using the correct handlers for a given validation cause.
Parameters#
cause#
ValidationCause
Returns#
Promise<unknown[]>
validateArrayFieldsStartingFrom()#
validateArrayFieldsStartingFrom<TField>(
field,
index,
cause): Promise<unknown[]>
Defined in: packages/form-core/src/FormApi.ts:1312
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.
Type Parameters#
• TField extends string
Parameters#
field#
TField
index#
number
cause#
ValidationCause
Returns#
Promise<unknown[]>
validateField()#
validateField<TField>(field, cause): unknown[] | Promise<unknown[]>
Defined in: packages/form-core/src/FormApi.ts:1353
Validates a specified field in the form using the correct handlers for a given validation type.
Type Parameters#
• TField extends string
Parameters#
field#
TField
cause#
ValidationCause
Returns#
unknown[] | Promise<unknown[]>