FieldGroupApi | TanStack Form Русский

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

Type Parameters

TFormData

TFormData

TFieldGroupData

TFieldGroupData

TFields

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

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 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:239

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:150

form

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

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

The form that called this field group.

store

store: ReadonlyStore<FieldGroupState<TFieldGroupData>>;

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

Accessors

state

Get Signature

get state(): FieldGroupState<TFieldGroupData>;

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

Returns

FieldGroupState<TFieldGroupData>

Methods

clearFieldValues()

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

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

Type Parameters

TField

TField extends string

Parameters

field

TField

opts?

UpdateMetaOptions

Returns

void

Implementation of

FormLikeAPI.clearFieldValues

deleteField()

deleteField<TField>(field): void;

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

Delete a field and its subfields.

Type Parameters

TField

TField extends string

Parameters

field

TField

Returns

void

Implementation of

FormLikeAPI.deleteField

getFieldMeta()

getFieldMeta<TField>(field): AnyFieldLikeMeta | undefined;

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

Gets the metadata of the specified field.

Type Parameters

TField

TField extends string

Parameters

field

TField

Returns

AnyFieldLikeMeta | undefined

Implementation of

FormLikeAPI.getFieldMeta

getFieldValue()

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

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

Gets the value of the specified field.

Type Parameters

TField

TField extends string

Parameters

field

TField

Returns

DeepValue<TFieldGroupData, TField>

Implementation of

FormLikeAPI.getFieldValue

handleSubmit()

Call Signature

handleSubmit(): Promise<void>;

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

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

Returns

Promise<void>

Implementation of

FormLikeAPI.handleSubmit

Call Signature

handleSubmit(submitMeta): Promise<void>;

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

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

Parameters

submitMeta

TSubmitMeta

Returns

Promise<void>

Implementation of

FormLikeAPI.handleSubmit

insertFieldValue()

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

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

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

Type Parameters

TField

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

FormLikeAPI.insertFieldValue

mount()

mount(): () => void;

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

Mounts the field group instance to listen to value changes.

TODO: Remove

Returns

(): void;

Returns

void

moveFieldValues()

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

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

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

opts?

UpdateMetaOptions

Returns

void

Implementation of

FormLikeAPI.moveFieldValues

pushFieldValue()

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

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

Pushes a value into an array field.

Type Parameters

TField

TField extends string

Parameters

field

TField

value

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

opts?

UpdateMetaOptions

Returns

void

Implementation of

FormLikeAPI.pushFieldValue

removeFieldValue()

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

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

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

Type Parameters

TField

TField extends string

Parameters

field

TField

index

number

opts?

UpdateMetaOptions

Returns

Promise<void>

Implementation of

FormLikeAPI.removeFieldValue

replaceFieldValue()

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

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

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

Type Parameters

TField

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

FormLikeAPI.replaceFieldValue

resetField()

resetField<TField>(field): void;

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

Resets the field value and meta to default state

Type Parameters

TField

TField extends string

Parameters

field

TField

Returns

void

Implementation of

FormLikeAPI.resetField

setFieldMeta()

setFieldMeta<TField>(field, updater): void;

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

Updates the metadata of the specified field.

Type Parameters

TField

TField extends string

Parameters

field

TField

updater

Updater<AnyFieldLikeMetaBase>

Returns

void

Implementation of

FormLikeAPI.setFieldMeta

setFieldValue()

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

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

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<TFieldGroupData, TField>>

opts?

UpdateMetaOptions

Returns

void

Implementation of

FormLikeAPI.setFieldValue

swapFieldValues()

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

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

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

Type Parameters

TField

TField extends string

Parameters

field

TField

index1

number

index2

number

opts?

UpdateMetaOptions

Returns

void

Implementation of

FormLikeAPI.swapFieldValues

validateAllFields()

validateAllFields(cause): Promise<unknown[]>;

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

Parameters

cause

ValidationCause

Returns

Promise<unknown[]>

Implementation of

FormLikeAPI.validateAllFields

validateArrayFieldsStartingFrom()

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

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

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

FormLikeAPI.validateArrayFieldsStartingFrom

validateField()

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

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

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

FormLikeAPI.validateField