Interface: FormApiArrayMethods<TFormData>#

Defined in: FormApi/FormApiArrayMethods.types.public.ts:90

Extended by#

• FormApi

Type Parameters#

TFormData#

TFormData

Properties#

clearFieldValues#

clearFieldValues: ClearFieldValuesFn<TFormData>;

Defined in: FormApi/FormApiArrayMethods.types.public.ts:134

Clear all values from an array field. If the field is not an array, this method will be ignored.

Param#

arrayFieldName

The name of the array field

filterFieldValues#

filterFieldValues: FilterFieldValuesFn<TFormData>;

Defined in: FormApi/FormApiArrayMethods.types.public.ts:152

Filter the values in an array field using a predicate function. If the field is not an array, this method will be ignored.

Param#

arrayFieldName

The name of the array field

Param#

predicate

The predicate function to filter values. Returns true to keep the value, false to remove it.

Param#

options

Optional update options including a custom thisArg for the predicate

insertFieldValue#

insertFieldValue: InsertFieldValueFn<TFormData>;

Defined in: FormApi/FormApiArrayMethods.types.public.ts:127

Insert a value into an array field at the specified index. If the field is not an array, this method will be ignored.

Param#

arrayFieldName

The name of the array field

Param#

index

The index at which to insert the value

Param#

value

The value to insert

Param#

options

Optional update options

moveFieldValue#

moveFieldValue: MoveFieldValueFn<TFormData>;

Defined in: FormApi/FormApiArrayMethods.types.public.ts:108

Move a value in an array field from one index to another. If the field is not an array, this method will be ignored.

Param#

arrayFieldName

The name of the array field

Param#

fromIndex

The current index of the value to move

Param#

toIndex

The index to move the value to

Param#

options

Optional update options

pushFieldValue#

pushFieldValue: PushFieldValueFn<TFormData>;

Defined in: FormApi/FormApiArrayMethods.types.public.ts:117

Push a value into an array field. If the field is not an array, this method will be ignored.

Param#

arrayFieldName

The name of the array field

Param#

value

The value to push

Param#

options

Optional update options

removeFieldValue#

removeFieldValue: RemoveFieldValueFn<TFormData>;

Defined in: FormApi/FormApiArrayMethods.types.public.ts:143

Remove a value from an array field at the specified index. If the field is not an array, this method will be ignored.

Param#

arrayFieldName

The name of the array field

Param#

index

The index of the value to remove

Param#

options

Optional update options

swapFieldValues#

swapFieldValues: SwapFieldValuesFn<TFormData>;

Defined in: FormApi/FormApiArrayMethods.types.public.ts:98

Swap two values in an array field. If the field is not an array, this method will be ignored.

Param#

arrayFieldName

The name of the array field

Param#

indexA

The index of the first value to swap

Param#

indexB

The index of the second value to swap