Hero Hook Form API / CreateFieldArrayCustomConfigOptions

Interface: CreateFieldArrayCustomConfigOptions<TFieldValues>

Defined in: utils/createFieldArrayCustomConfig.tsx:139

Options for creating a custom field array config

Type Parameters

TFieldValues

TFieldValues extends FieldValues

The form data type

Properties

name

name: ArrayPath<TFieldValues>

Defined in: utils/createFieldArrayCustomConfig.tsx:143

Field array name

label?

optional label: string

Defined in: utils/createFieldArrayCustomConfig.tsx:145

Optional label for the field array

getItemFieldConfig()?

optional getItemFieldConfig: (props) => ZodFormFieldConfig<TFieldValues> | null

Defined in: utils/createFieldArrayCustomConfig.tsx:152

Return a single field config for this item; the array helper will render one FormField. Use with createCustomFieldConfigForItem when each item’s control type depends on item data (e.g. custom fields: look up field def by customFieldId, then createCustomFieldConfigForItem). When provided, renderItem is optional.

Parameters

props

FieldArrayItemRenderProps<TFieldValues, ArrayPath<TFieldValues>>

Returns

ZodFormFieldConfig<TFieldValues> | null

renderItem()?

optional renderItem: (props) => ReactNode

Defined in: utils/createFieldArrayCustomConfig.tsx:156

Render function for each array item (optional if getItemFieldConfig is provided)

Parameters

props

FieldArrayItemRenderProps<TFieldValues, ArrayPath<TFieldValues>>

Returns

ReactNode

renderAddButton()?

optional renderAddButton: (props) => ReactNode

Defined in: utils/createFieldArrayCustomConfig.tsx:160

Optional render function for add button

Parameters

props

onAdd

() => void

canAdd

boolean

Returns

ReactNode

defaultItem()?

optional defaultItem: () => any

Defined in: utils/createFieldArrayCustomConfig.tsx:165

Function to create default item when adding new array item

Returns

any

min?

optional min: number

Defined in: utils/createFieldArrayCustomConfig.tsx:167

Minimum number of items

max?

optional max: number

Defined in: utils/createFieldArrayCustomConfig.tsx:169

Maximum number of items

enableReordering?

optional enableReordering: boolean

Defined in: utils/createFieldArrayCustomConfig.tsx:171

Enable reordering of array items

readOnly?

optional readOnly: boolean

Defined in: utils/createFieldArrayCustomConfig.tsx:173

When true, no add button is shown; readOnly is passed to renderItem/getItemFieldConfig so you can hide remove/reorder

className?

optional className: string

Defined in: utils/createFieldArrayCustomConfig.tsx:175

Optional className