API

This library provides the following Final Form mutators. They are intended to mimic the array mutations available Array.prototype in JavaScript.

The name argument always refers to the field to be mutated.

(name: string, value: Array<any>) => void

Concatenates an array at the end of the field array.

(name: string, index: number, value: any) => void`

Inserts a value into the specified index of the field array.

(name: string, from: number, to: number) => void

Moves a value from one index to another index in the field array.

(name: string) => any

Pops a value off the end of an field array. Returns the value.

(name: string, value: any) => void

Pushes a value onto the end of an field array.

(name: string, index: number) => any

Removes a value from the specified index of the field array. Returns the removed value.

(name: string, indexes: Array<number>) => void

Removes the values at the specified indexes of the field array.

(name: string) => any

Removes a value from the beginning of the field array. Returns the value.

(name: string, indexA: number, indexB: number) => void

Swaps the position of two values in the field array.

(name: string, value: any) => void

Inserts a value onto the beginning of the field array.

(name: string, index: number, value: any) => void

Updates a value of the specified index of the field array.