useFieldArray

Creates a reactive field array store of a specific field array within a form store.

const fieldArray = useFieldArray<TSchema, TFieldArrayPath>(form, config);

Generics

• TSchema extends Schema
• TFieldArrayPath extends RequiredPath

Parameters

• form FormStore<TSchema>
• config UseFieldArrayConfig<TSchema, TFieldArrayPath>

Explanation

With useFieldArray you create a reactive field array store for a specific array field within your form. The field array store provides reactive access to the array items (by their IDs), validation errors, touched state, and more. This is particularly useful when working with dynamic arrays of fields that users can add or remove.

Returns

• fieldArray FieldArrayStore<TSchema, TFieldArrayPath>

Related

The following APIs can be combined with useFieldArray.

Composables

• useForm,
• useField

Components

• Field,
• FieldArray,
• Form

Methods

• focus,
• getAllErrors,
• getErrors,
• getInput,
• insert,
• move,
• remove,
• replace,
• reset,
• setErrors,
• setInput,
• swap,
• validate