Skip to content
Source
Sign inSign up
TanStack/form
Open History to see the last commit

fieldgroupapi.md

810 lines14.6 KB

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

Defined in: packages/form-core/src/FieldGroupApi.ts:112

Type Parameters

• TFormData

• TFieldGroupData

• TFields extends | DeepKeysOfType<TFormData, TFieldGroupData | null | undefined> | FieldsMap<TFormData, TFieldGroupData>

• 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<TFieldGroupData, TSubmitMeta>

Constructors

new FieldGroupApi()

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

Defined in: packages/form-core/src/FieldGroupApi.ts:238

Constructs a new FieldGroupApi instance with the given form options.

Parameters

opts

FieldGroupOptions<TFormData, TFieldGroupData, TFields, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>

Returns

FieldGroupApi<TFormData, TFieldGroupData, TFields, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>

Properties

fieldsMap

readonly fieldsMap: TFields;

Defined in: packages/form-core/src/FieldGroupApi.ts:149


form

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

Defined in: packages/form-core/src/FieldGroupApi.ts:134

The form that called this field group.


store

store: Derived<FieldGroupState<TFieldGroupData>>;

Defined in: packages/form-core/src/FieldGroupApi.ts:229

Accessors

state

Get Signature

get state(): FieldGroupState<TFieldGroupData>

Defined in: packages/form-core/src/FieldGroupApi.ts:231

Returns

FieldGroupState<TFieldGroupData>

Methods

clearFieldValues()

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

Defined in: packages/form-core/src/FieldGroupApi.ts:510

Type Parameters

• TField extends string

Parameters

field

TField

opts?

UpdateMetaOptions

Returns

void

Implementation of

FieldManipulator.clearFieldValues

deleteField()

deleteField<TField>(field): void

Defined in: packages/form-core/src/FieldGroupApi.ts:397

Delete a field and its subfields.

Type Parameters

• TField extends string

Parameters

field

TField

Returns

void

Implementation of

FieldManipulator.deleteField

getFieldMeta()

getFieldMeta<TField>(field): undefined | AnyFieldMeta

Defined in: packages/form-core/src/FieldGroupApi.ts:365

Gets the metadata of the specified field.

Type Parameters

• TField extends string

Parameters

field

TField

Returns

undefined | AnyFieldMeta

Implementation of

FieldManipulator.getFieldMeta

getFieldValue()

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

Defined in: packages/form-core/src/FieldGroupApi.ts:353

Gets the value of the specified field.

Type Parameters

• TField extends string

Parameters

field

TField

Returns

DeepValue<TFieldGroupData, TField>

Implementation of

FieldManipulator.getFieldValue

handleSubmit()

Call Signature

handleSubmit(): Promise<void>

Defined in: packages/form-core/src/FieldGroupApi.ts:343

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/FieldGroupApi.ts:344

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

Parameters
submitMeta

TSubmitMeta

Returns

Promise<void>

Implementation of
FieldManipulator.handleSubmit

insertFieldValue()

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

Defined in: packages/form-core/src/FieldGroupApi.ts:422

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

Type Parameters

• TField extends string

Parameters

field

TField

index

number

value

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

opts?

UpdateMetaOptions

Returns

Promise<void>

Implementation of

FieldManipulator.insertFieldValue

mount()

mount(): () => void

Defined in: packages/form-core/src/FieldGroupApi.ts:307

Mounts the field group instance to listen to value changes.

Returns

Function

Returns

void


moveFieldValues()

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

Defined in: packages/form-core/src/FieldGroupApi.ts:496

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

Implementation of

FieldManipulator.moveFieldValues

pushFieldValue()

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

Defined in: packages/form-core/src/FieldGroupApi.ts:404

Pushes a value into an array field.

Type Parameters

• TField extends string

Parameters

field

TField

value

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

opts?

UpdateMetaOptions

Returns

void

Implementation of

FieldManipulator.pushFieldValue

removeFieldValue()

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

Defined in: packages/form-core/src/FieldGroupApi.ts:466

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>

Implementation of

FieldManipulator.removeFieldValue

replaceFieldValue()

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

Defined in: packages/form-core/src/FieldGroupApi.ts:444

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

Type Parameters

• TField extends string

Parameters

field

TField

index

number

value

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

opts?

UpdateMetaOptions

Returns

Promise<void>

Implementation of

FieldManipulator.replaceFieldValue

resetField()

resetField<TField>(field): void

Defined in: packages/form-core/src/FieldGroupApi.ts:520

Resets the field value and meta to default state

Type Parameters

• TField extends string

Parameters

field

TField

Returns

void

Implementation of

FieldManipulator.resetField

setFieldMeta()

setFieldMeta<TField>(field, updater): void

Defined in: packages/form-core/src/FieldGroupApi.ts:372

Updates the metadata of the specified field.

Type Parameters

• TField extends string

Parameters

field

TField

updater

Updater<AnyFieldMetaBase>

Returns

void

Implementation of

FieldManipulator.setFieldMeta

setFieldValue()

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

Defined in: packages/form-core/src/FieldGroupApi.ts:382

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

Type Parameters

• TField extends string

Parameters

field

TField

updater

Updater<DeepValue<TFieldGroupData, TField>>

opts?

UpdateMetaOptions

Returns

void

Implementation of

FieldManipulator.setFieldValue

swapFieldValues()

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

Defined in: packages/form-core/src/FieldGroupApi.ts:479

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

Implementation of

FieldManipulator.swapFieldValues

validateAllFields()

validateAllFields(cause): Promise<unknown[]>

Defined in: packages/form-core/src/FieldGroupApi.ts:524

Parameters

cause

ValidationCause

Returns

Promise<unknown[]>

Implementation of

FieldManipulator.validateAllFields

validateArrayFieldsStartingFrom()

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

Defined in: packages/form-core/src/FieldGroupApi.ts:316

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

Implementation of

FieldManipulator.validateArrayFieldsStartingFrom

validateField()

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

Defined in: packages/form-core/src/FieldGroupApi.ts:333

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

Implementation of

FieldManipulator.validateField