Class: FormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>#
Defined in: packages/form-core/src/FormApi.ts:848
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#
TFormData
TOnMount#
TOnMount extends undefined | FormValidateOrFn<TFormData>
TOnChange#
TOnChange extends undefined | FormValidateOrFn<TFormData>
TOnChangeAsync#
TOnChangeAsync extends undefined | FormAsyncValidateOrFn<TFormData>
TOnBlur#
TOnBlur extends undefined | FormValidateOrFn<TFormData>
TOnBlurAsync#
TOnBlurAsync extends undefined | FormAsyncValidateOrFn<TFormData>
TOnSubmit#
TOnSubmit extends undefined | FormValidateOrFn<TFormData>
TOnSubmitAsync#
TOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFormData>
TOnDynamic#
TOnDynamic extends undefined | FormValidateOrFn<TFormData>
TOnDynamicAsync#
TOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TFormData>
TOnServer#
TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>
TSubmitMeta#
TSubmitMeta = never
Constructors#
Constructor#
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:954
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>>;
Defined in: packages/form-core/src/FormApi.ts:880
fieldInfo#
fieldInfo: Record<DeepKeys<TFormData>, FieldInfo<TFormData>>;
Defined in: packages/form-core/src/FormApi.ts:928
A record of field information for each field in the form.
fieldMetaDerived#
fieldMetaDerived: Store<Partial<Record<DeepKeys<TFormData>, AnyFieldMeta>>>;
Defined in: packages/form-core/src/FormApi.ts:895
options#
options: FormOptions<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta> = {};
Defined in: packages/form-core/src/FormApi.ts:865
The options for the form.
store#
store: ReadonlyStore<FormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer>>;
Defined in: packages/form-core/src/FormApi.ts:910
Accessors#
formId#
Get Signature#
get formId(): string;
Defined in: packages/form-core/src/FormApi.ts:1335
Returns#
string
state#
Get Signature#
get state(): FormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer>;
Defined in: packages/form-core/src/FormApi.ts:930
Returns#
FormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer>
Methods#
_handleSubmit()#
_handleSubmit(submitMeta?): Promise<void>;
Defined in: packages/form-core/src/FormApi.ts:2060
Handles the form submission, performs validation, and calls the appropriate onSubmit or onSubmitInvalid callbacks.
Parameters#
submitMeta?#
TSubmitMeta
Returns#
Promise<void>
clearFieldValues()#
clearFieldValues<TField>(field, options?): void;
Defined in: packages/form-core/src/FormApi.ts:2527
Clear all values within an array field.
Type Parameters#
TField#
TField extends string
Parameters#
field#
TField
options?#
UpdateMetaOptions
Returns#
void
Implementation of#
FieldManipulator.clearFieldValues
deleteField()#
deleteField<TField>(field): void;
Defined in: packages/form-core/src/FormApi.ts:2319
Type Parameters#
TField#
TField extends string
Parameters#
field#
TField
Returns#
void
Implementation of#
FieldManipulator.deleteField
getAllErrors()#
getAllErrors(): object;
Defined in: packages/form-core/src/FormApi.ts:2642
Returns form and field level errors
Returns#
object
fields#
fields: Record<DeepKeys<TFormData>, {
errorMap: ValidationErrorMap;
errors: ValidationError[];
}>;
form#
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>>;
form.errors#
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>;
Defined in: packages/form-core/src/FormApi.ts:2222
Gets the field info of the specified field.
Type Parameters#
TField#
TField extends string
Parameters#
field#
TField
Returns#
FieldInfo<TFormData>
getFieldMeta()#
getFieldMeta<TField>(field): AnyFieldMeta | undefined;
Defined in: packages/form-core/src/FormApi.ts:2213
Gets the metadata of the specified field.
Type Parameters#
TField#
TField extends string
Parameters#
field#
TField
Returns#
AnyFieldMeta | undefined
Implementation of#
FieldManipulator.getFieldMeta
getFieldValue()#
getFieldValue<TField>(field): DeepValue<TFormData, TField>;
Defined in: packages/form-core/src/FormApi.ts:2206
Gets the value of the specified field.
Type Parameters#
TField#
TField extends string
Parameters#
field#
TField
Returns#
DeepValue<TFormData, TField>
Implementation of#
FieldManipulator.getFieldValue
handleSubmit()#
Call Signature#
handleSubmit(): Promise<void>;
Defined in: packages/form-core/src/FormApi.ts:2051
Handles the form submission, performs validation, and calls the appropriate onSubmit or onSubmitInvalid callbacks.
Returns#
Promise<void>
Implementation of#
FieldManipulator.handleSubmit
Call Signature#
handleSubmit(submitMeta): Promise<void>;
Defined in: packages/form-core/src/FormApi.ts:2052
Parameters#
submitMeta#
TSubmitMeta
Returns#
Promise<void>
Implementation of#
FieldManipulator.handleSubmit
insertFieldValue()#
insertFieldValue<TField>(
field,
index,
value,
options?): Promise<void>;
Defined in: packages/form-core/src/FormApi.ts:2357
Type Parameters#
TField#
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
mount()#
mount(): () => void;
Defined in: packages/form-core/src/FormApi.ts:1364
Returns#
(): void;
Returns#
void
moveFieldValues()#
moveFieldValues<TField>(
field,
index1,
index2,
options?): void;
Defined in: packages/form-core/src/FormApi.ts:2495
Moves the value at the first specified index to the second specified index within an array field.
Type Parameters#
TField#
TField extends string
Parameters#
field#
TField
index1#
number
index2#
number
options?#
UpdateMetaOptions
Returns#
void
Implementation of#
FieldManipulator.moveFieldValues
parseValuesWithSchema()#
parseValuesWithSchema(schema):
| {
fields: Record<string, StandardSchemaV1Issue[]>;
form: Record<string, StandardSchemaV1Issue[]>;
}
| undefined;
Defined in: packages/form-core/src/FormApi.ts:2706
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#
| {
fields: Record<string, StandardSchemaV1Issue[]>;
form: Record<string, StandardSchemaV1Issue[]>;
}
| undefined
parseValuesWithSchemaAsync()#
parseValuesWithSchemaAsync(schema): Promise<
| {
fields: Record<string, StandardSchemaV1Issue[]>;
form: Record<string, StandardSchemaV1Issue[]>;
}
| undefined>;
Defined in: packages/form-core/src/FormApi.ts:2718
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<
| {
fields: Record<string, StandardSchemaV1Issue[]>;
form: Record<string, StandardSchemaV1Issue[]>;
}
| undefined>
pushFieldValue()#
pushFieldValue<TField>(
field,
value,
options?): void;
Defined in: packages/form-core/src/FormApi.ts:2343
Pushes a value into an array field.
Type Parameters#
TField#
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
removeFieldValue()#
removeFieldValue<TField>(
field,
index,
options?): Promise<void>;
Defined in: packages/form-core/src/FormApi.ts:2423
Removes a value from an array field at the specified index.
Type Parameters#
TField#
TField extends string
Parameters#
field#
TField
index#
number
options?#
UpdateMetaOptions
Returns#
Promise<void>
Implementation of#
FieldManipulator.removeFieldValue
replaceFieldValue()#
replaceFieldValue<TField>(
field,
index,
value,
options?): Promise<void>;
Defined in: packages/form-core/src/FormApi.ts:2394
Replaces a value into an array field at the specified index.
Type Parameters#
TField#
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
reset()#
reset(values?, opts?): void;
Defined in: packages/form-core/src/FormApi.ts:1505
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:2560
Resets the field value and meta to default state
Type Parameters#
TField#
TField extends string
Parameters#
field#
TField
Returns#
void
Implementation of#
FieldManipulator.resetField
resetFieldMeta()#
resetFieldMeta<TField>(fieldMeta): Partial<Record<TField, AnyFieldMeta>>;
Defined in: packages/form-core/src/FormApi.ts:2263
resets every field's meta
Type Parameters#
TField#
TField extends string
Parameters#
fieldMeta#
Partial<Record<TField, AnyFieldMeta>>
Returns#
Partial<Record<TField, AnyFieldMeta>>
setErrorMap()#
setErrorMap(errorMap): void;
Defined in: packages/form-core/src/FormApi.ts:2578
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;
Defined in: packages/form-core/src/FormApi.ts:2242
Updates the metadata of the specified field.
Type Parameters#
TField#
TField extends string
Parameters#
field#
TField
updater#
Returns#
void
Implementation of#
FieldManipulator.setFieldMeta
setFieldValue()#
setFieldValue<TField>(
field,
updater,
opts?): void;
Defined in: packages/form-core/src/FormApi.ts:2279
Sets the value of the specified field and optionally updates the touched state.
Type Parameters#
TField#
TField extends string
Parameters#
field#
TField
updater#
Updater<DeepValue<TFormData, TField>>
opts?#
UpdateMetaOptions
Returns#
void
Implementation of#
FieldManipulator.setFieldValue
swapFieldValues()#
swapFieldValues<TField>(
field,
index1,
index2,
options?): void;
Defined in: packages/form-core/src/FormApi.ts:2463
Swaps the values at the specified indices within an array field.
Type Parameters#
TField#
TField extends string
Parameters#
field#
TField
index1#
number
index2#
number
options?#
UpdateMetaOptions
Returns#
void
Implementation of#
FieldManipulator.swapFieldValues
update()#
update(options?): void;
Defined in: packages/form-core/src/FormApi.ts:1438
Updates the form options and form state.
Parameters#
options?#
FormOptions<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>
Returns#
void
validateAllFields()#
validateAllFields(cause): Promise<unknown[]>;
Defined in: packages/form-core/src/FormApi.ts:1531
Validates all fields using the correct handlers for a given validation cause.
Parameters#
cause#
ValidationCause
Returns#
Promise<unknown[]>
Implementation of#
FieldManipulator.validateAllFields
validateArrayFieldsStartingFrom()#
validateArrayFieldsStartingFrom<TField>(
field,
index,
cause): Promise<unknown[]>;
Defined in: packages/form-core/src/FormApi.ts:1561
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#
TField extends string
Parameters#
field#
TField
index#
number
cause#
ValidationCause
Returns#
Promise<unknown[]>
Implementation of#
FieldManipulator.validateArrayFieldsStartingFrom
validateField()#
validateField<TField>(field, cause): any[] | Promise<any[]>;
Defined in: packages/form-core/src/FormApi.ts:1602
Validates a specified field in the form using the correct handlers for a given validation type.
Type Parameters#
TField#
TField extends string
Parameters#
field#
TField
cause#
ValidationCause
Returns#
any[] | Promise<any[]>
Implementation of#
FieldManipulator.validateField