FieldArray

Headless field array component that provides reactive properties and state for managing array fields. The field array component takes a form store, path to array field, and a render function that receives a field array store to manage array items and handle array operations.

<FieldArray of={…} path={…} render$={…} />

Generics

• TSchema extends Schema
• TFieldArrayPath extends RequiredPath

Properties

• of FormStore<TSchema>
• path ValidArrayPath<v.InferInput<TSchema>, TFieldArrayPath>
• render$ QRL<(store: FieldArrayStore<TSchema, TFieldArrayPath>) => JSXOutput>

Explanation

The FieldArray component is a headless component that doesn't render any UI itself. Instead, it provides a render prop function via the render$ prop that receives a FieldArrayStore containing all the reactive state and methods needed to manage an array of form fields.

The component automatically handles array field registration, validation, and state management through the of prop that references the form store.

Related

Hooks

• useForm$,
• useFieldArray

Components

• Field,
• Form

Methods

• insert,
• move,
• remove,
• replace,
• swap