Skip to Content
APIInterfacesInterface: FieldArrayItemRenderProps<TFieldValues, TArrayPath>

Hero Hook Form API v2.15.0


Hero Hook Form API / FieldArrayItemRenderProps

Interface: FieldArrayItemRenderProps<TFieldValues, TArrayPath>

Defined in: utils/createFieldArrayCustomConfig.tsx:115 

Props passed to renderItem or getItemFieldConfig for each array item

Type Parameters

TFieldValues

TFieldValues extends FieldValues

TArrayPath

TArrayPath extends ArrayPath<TFieldValues>

Properties

index

index: number

Defined in: utils/createFieldArrayCustomConfig.tsx:119 


field

field: FieldArrayWithId<TFieldValues, TArrayPath>

Defined in: utils/createFieldArrayCustomConfig.tsx:120 


fields

fields: FieldArrayWithId<TFieldValues, TArrayPath>[]

Defined in: utils/createFieldArrayCustomConfig.tsx:121 


form

form: UseFormReturn<TFieldValues>

Defined in: utils/createFieldArrayCustomConfig.tsx:122 


control

control: Control<TFieldValues>

Defined in: utils/createFieldArrayCustomConfig.tsx:123 


errors

errors: FieldErrors<TFieldValues>

Defined in: utils/createFieldArrayCustomConfig.tsx:124 


canMoveUp

canMoveUp: boolean

Defined in: utils/createFieldArrayCustomConfig.tsx:125 


canMoveDown

canMoveDown: boolean

Defined in: utils/createFieldArrayCustomConfig.tsx:126 


onMoveUp()

onMoveUp: () => void

Defined in: utils/createFieldArrayCustomConfig.tsx:127 

Returns

void


onMoveDown()

onMoveDown: () => void

Defined in: utils/createFieldArrayCustomConfig.tsx:128 

Returns

void


onRemove()

onRemove: () => void

Defined in: utils/createFieldArrayCustomConfig.tsx:129 

Returns

void


readOnly?

optional readOnly: boolean

Defined in: utils/createFieldArrayCustomConfig.tsx:131 

When true, add/remove/reorder are hidden; use to hide your own buttons