GTKX

API Reference / @gtkx/forms / useFieldArray

Function: useFieldArray() ​

useFieldArray<TFieldValues, TFieldArrayName, TKeyName, TTransformedValues>(props): UseFieldArrayReturn<TFieldValues, TFieldArrayName, TKeyName>

Hook for dynamic field arrays. Provides fields and mutation methods: append, prepend, remove, insert, swap, move, update, replace.

Type Parameters ​

TFieldValues ​

TFieldValues extends FieldValues = FieldValues

TFieldArrayName ​

TFieldArrayName extends string = FieldArrayPath<TFieldValues>

TKeyName ​

TKeyName extends string = "id"

TTransformedValues ​

TTransformedValues = TFieldValues

Parameters ​

props ​

UseFieldArrayProps<TFieldValues, TFieldArrayName, TKeyName, TTransformedValues>

Returns ​

UseFieldArrayReturn<TFieldValues, TFieldArrayName, TKeyName>

See ​

API

Example ​

tsx
const { fields, append } = useFieldArray({ control, name: "items" });
return fields.map((f, i) => <input key={f.id} {...register(`items.${i}.name`)} />);