Configuration
Il est possible de configurer plusieurs options lors de la génération du formulaire.
Paramètres
| Paramètre | Description |
|---|---|
| groupId | Ce paramètre permet d'aller chercher les champs du formulaire. Il désigne l'identifiant d'un groupe. La valeur par défaut est undefined. |
| locale | Ce paramètre est utilisé pour définir la langue à utiliser. La valeur par défaut est en_US. Voir la liste des langues disponibles. |
| submit_button_text | Ce paramètre est utilisé pour définir le texte du boutton d'envoi. |
| default_select_text | Ce paramètre est utilisé pour définir le texte des sélections par défaut des radio buttons et des listes déroulantes. La valeur par défaut est None. |
| layout | Ce paramètre permet de délimiter des sections. Par défaut, aucun layout n'est utilisé. Voir l'exemple d'utilisation plus bas. |
| onPostRender | Ce paramètre doit être une fonction. Elle est appelée lorsque le formulaire a été généré. Utilisation: onPostRender = function() { ... } |
| onSuccess | Ce paramètre doit être une fonction, reçevant comme données les informations du membre lorsque l'envoi du formulaire est un succès. Aucune fonction n'est appelée par défaut. Utilisation: onSuccess = function(member) { ... } |
| onError | Ce paramètre doit être une fonction qui est appelée lorsqu'une erreur s'est produite lors de l'envoi du formulaire. Aucune fonction n'est appelée par défaut. Utilisation: onError = function() { ... } |
| onCompleted | Ce paramètre doit être une fonction qui est appelée, que le retour soit un succès ou une erreur lors de l'envoi du formulaire. Aucune fonction n'est appelée par défaut. Utilisation: onCompleted = function() { ... } |
Exemples
Pour l'utilisation du paramètre layout:
layout: {
'test': {
title: 'Section dédiée au courriel',
properties: ['email']
},
// ...
}
Méthodes
Pour utiliser les méthodes, il faut avoir l'objet de type userboatForm. Par exemple:
$('#form').userboatForm().trigger('init');
Les méthodes disponibles sont les suivantes:
| Paramètre | Description |
|---|---|
| .trigger('init') | Cette méthode permet de lancer la construction du formulaire. |
| .trigger('destroy') | Cette méthode permet de supprimer un formulaire. Les ressources sont libérées convenablement. |