npm package: @heridux/form-arrays
Description: Manage easily array fields with heridux
Author: Yannick Bochatay
Latest version: 0.0.1

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

### Table of Contents

-   [FormArray][1]
    -   [Parameters][2]
-   [FormStore][3]
    -   [Parameters][4]
    -   [formArrayDef][5]
        -   [Parameters][6]
    -   [formArrayAdd][7]
        -   [Parameters][8]
    -   [formArrayRemove][9]
        -   [Parameters][10]
    -   [formArrayReset][11]
        -   [Parameters][12]
    -   [formArrayMove][13]
        -   [Parameters][14]
    -   [getFormArrayLength][15]
        -   [Parameters][16]
    -   [getFormArray][17]
        -   [Parameters][18]

## FormArray

Constructeur de champs de type tableau

### Parameters

-   `obj` **[Object][19]** objet décrivant un élément du tableau

Returns **[FormArray][20]** instance

## FormStore

**Extends HeriduxForm**

Gestion des tableaux de formulaire avec Heridux

### Parameters

-   `STATE_PROPERTY`  

### formArrayDef

Définit la structure des éléments du tableau si on ne l'a pas fait dans defineForm

#### Parameters

-   `path` **([String][21] \| [Array][22])** chemin du tableau de formulaire
-   `itemDefinition` **[Object][19]** description de la structure des éléments du tableau

Returns **[undefined][23]** 

### formArrayAdd

Ajoute un élément au tableau

#### Parameters

-   `path` **([String][21] \| [Array][22])** chemin du tableau de formulaire
-   `ind` **[Number][24]** indice où ajouter l'élément (à la fin par défaut)

Returns **[Number][24]** l'indice où a été ajouté l'élément

### formArrayRemove

Supprime un élément du tableau

#### Parameters

-   `path` **([String][21] \| [Array][22])** chemin du tableau de formulaire
-   `index` **[Number][24]** indice de l'élément à supprimer (le dernier par défaut) (optional, default `null`)

Returns **[undefined][23]** 

### formArrayReset

Supprime tous les éléments du tableau

#### Parameters

-   `path` **([String][21] \| [Array][22])** chemin du tableau de formulaire

Returns **[undefined][23]** 

### formArrayMove

Déplace un élément du tableau

#### Parameters

-   `path` **([String][21] \| [Array][22])** chemin du tableau de formulaire
-   `oldIndex` **[Number][24]** indice de l'élément à déplacer
-   `newIndex` **[Number][24]** indice où déplacer l'élément

Returns **[undefined][23]** 

### getFormArrayLength

Renvoie la longueur du tableau

#### Parameters

-   `path` **([String][21] \| [Array][22])** chemin du du tableau de formulaire
-   `state` **Immutable** optionnel, état du store

Returns **[Number][24]** longueur du tableau

### getFormArray

Renvoie un objet permettant de manipuler plus facilement le tableau de formulaire

#### Parameters

-   `path` **([String][21] \| [Array][22])** chemin du tableau de formulaire

Returns **[Object][19]** objet contenant les méthodes add, remove, move et la propriété length

[1]: #formarray

[2]: #parameters

[3]: #formstore

[4]: #parameters-1

[5]: #formarraydef

[6]: #parameters-2

[7]: #formarrayadd

[8]: #parameters-3

[9]: #formarrayremove

[10]: #parameters-4

[11]: #formarrayreset

[12]: #parameters-5

[13]: #formarraymove

[14]: #parameters-6

[15]: #getformarraylength

[16]: #parameters-7

[17]: #getformarray

[18]: #parameters-8

[19]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object

[20]: #formarray

[21]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String

[22]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array

[23]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined

[24]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number