1.0.2 • Published 4 years ago
collab-form v1.0.2
Collab
Plugin jQuery de RealTime
Après avoir installé le package avec la commande yarn add collab-form, ce dernier s'installe de cette manière :
require('collab-form');
...
var collab = $('form').Collab({
address: "ws://localhost:8080",
code: "123",
realtime: true,
userCode: "username",
lockFields: true,
lockFieldsAddClass: "inputLock",
connInfoTarget: ".nbUsers",
connInfoText: "Nombre d'utilisateurs connectés : %n <br> Utilisateurs : %u",
connInfoCloseText: "Vous avez été déconnecté"
});Son utilisation requiert jQuery.
| Paramètres | Détails | Requis |
|---|---|---|
| address | adresse du serveur node ouvrant le socket | oui |
| code | identifiant unique de la page | oui |
| realtime | false par défaut, permet de voir les modifications en temps réel des autres utilisateurs | non |
| userCode | identifiant unique du user. S'il n'est pas précisé, un token est généré pour chaque user | non |
| lockFields | false par défaut, ajoute l'attribut readOnly aux inputs modifier par l'utilisateur courant sur le client de tous les autres | non |
| lockFieldsAddClass | permet d'ajouter des classes aux inputs modifier | non |
| connInfoTarget | noeud(s) où se situeront les connInfoText et connInfoCloseText | non |
| connInfoText | texte d'info. %n est le nombre d'utilisateur, et %u les userCode des membres actuellement connectés | non |
| connInfoCloseText | texte d'info en cas de panne du serveur | non |