FieldArrayRenderProps

Premium

Contains props that are passed to components rendered inside FieldArray components.

Name	Type	Default	Description
children	any		Contains child elements that are passed to the FieldArray.
modified	boolean		Shows whether the field value has changed from its initial value. Becomes true when the field value changes for the first time.
name	string		Contains the field name in the form state.
onInsert	(options: { index: number; value: any; }) => void		Inserts a value at a specific position in the array.
onMove	(options: { nextIndex: number; prevIndex: number; }) => void		Moves a value from one position to another in the array.
onPop	() => any		Removes and returns the last value from the array.
onPush	(options: { value: any; }) => void		Adds a value to the end of the array.
onRemove	(options: { index: number; }) => any		Removes a value at a specific position in the array.
onReplace	(options: { index: number; value: any; }) => void		Replaces a value at a specific position in the array.
onUnshift	(options: { value: any; }) => number		Adds a value to the beginning of the array.
touched	boolean		Shows whether the user has interacted with the field. Becomes true when the field loses focus.
valid	boolean		Shows whether the field passes validation and has been touched.
validationMessage	"null" | string		Contains the error message from validation. The field is valid when this is empty.
value	any		Represents the current value of the FieldArray (see example).
visited	boolean		Shows whether the user has focused on the field. Becomes true when the field receives focus.