@heridux/form-arrays v0.0.1

Table of Contents

• FormArray
  • Parameters
• FormStore
  • Parameters
  • formArrayDef
    • Parameters
  • formArrayAdd
    • Parameters
  • formArrayRemove
    • Parameters
  • formArrayReset
    • Parameters
  • formArrayMove
    • Parameters
  • getFormArrayLength
    • Parameters
  • getFormArray
    • Parameters

FormArray

Constructeur de champs de type tableau

Parameters

• obj Object objet décrivant un élément du tableau

Returns FormArray 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 | Array) chemin du tableau de formulaire
• itemDefinition Object description de la structure des éléments du tableau

Returns undefined

formArrayAdd

Ajoute un élément au tableau

Parameters

• path (String | Array) chemin du tableau de formulaire
• ind Number indice où ajouter l'élément (à la fin par défaut)

Returns Number l'indice où a été ajouté l'élément

formArrayRemove

Supprime un élément du tableau

Parameters

• path (String | Array) chemin du tableau de formulaire
• index Number indice de l'élément à supprimer (le dernier par défaut) (optional, default null)

Returns undefined

formArrayReset

Supprime tous les éléments du tableau

Parameters

• path (String | Array) chemin du tableau de formulaire

Returns undefined

formArrayMove

Déplace un élément du tableau

Parameters

• path (String | Array) chemin du tableau de formulaire
• oldIndex Number indice de l'élément à déplacer
• newIndex Number indice où déplacer l'élément

Returns undefined

getFormArrayLength

Renvoie la longueur du tableau

Parameters

• path (String | Array) chemin du du tableau de formulaire
• state Immutable optionnel, état du store

Returns Number longueur du tableau

getFormArray

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

Parameters

• path (String | Array) chemin du tableau de formulaire

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