diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md new file mode 100644 index 0000000..57d889b --- /dev/null +++ b/DOCUMENTATION.md @@ -0,0 +1,299 @@ + + +### Table of Contents + +- [Constructor][1] + - [Parameters][2] + - [each][3] + - [Parameters][4] + - [addClass][5] + - [Parameters][6] + - [removeClass][7] + - [Parameters][8] + - [replaceClass][9] + - [Parameters][10] + - [setAttr][11] + - [Parameters][12] + - [delAttr][13] + - [Parameters][14] + - [setHidden][15] + - [setReadOnly][16] + - [setDisabled][17] + - [delHidden][18] + - [delReadOnly][19] + - [delDisabled][20] + - [toggleHidden][21] + - [toggleReadOnly][22] + - [toggleDisabled][23] + - [on][24] + - [Parameters][25] + - [onClick][26] + - [Parameters][27] + - [found][28] + - [first][29] + - [last][30] +- [gsd][31] + - [Parameters][32] + - [version][33] +- [gsd][34] + - [version][35] + +## Constructor + +Création du constructeur + +### Parameters + +- `selector` **[String][36]** Sélecteur utilisé +- `scope` **[HTMLElement][37]** Racine de la recherche + +### each + +Application d'une fonction sur chacun des éléments + +#### Parameters + +- `callback` **[Function][38]** La fonction de rappel + +### addClass + +Ajout d'une classe aux éléments sélectionnés + +#### Parameters + +- `className` **[String][36]** Le nom de la classe à ajouter + +Returns **this** Chainage + +### removeClass + +Ajout d'une classe aux éléments sélectionnés + +#### Parameters + +- `className` **[String][36]** Le nom de la classe à ajouter + +Returns **this** Chainage + +### replaceClass + +Remplace une classe par une autre dans les éléments sélectionnés + +#### Parameters + +- `oldClass` **[String][36]** Nom de la classe à remplacer +- `newClass` **[String][36]** Nom de la classe de remplacement + +Returns **this** Chainage + +### setAttr + +Définit un attribut et sa valeur + +#### Parameters + +- `attr` **[String][36]** Nom de l'attribut +- `value` **[String][36]** Valeur de l'attribut + +Returns **this** Chainage + +### delAttr + +Supprime un attribut dans les éléments sélectionnés + +#### Parameters + +- `attr` **[String][36]** Nom de l'attribut à supprimer + +Returns **this** Chainage + +### setHidden + +Ajoute l'attribut hidden aux éléments sélectionnés + +Returns **this** Chainage + +### setReadOnly + +Ajoute l'attribut readonly aux éléments sélectionnés + +Returns **this** Chainage + +### setDisabled + +Ajoute l'attribut disabled aux éléments sélectionnés + +Returns **this** Chainage + +### delHidden + +Supprime l'attribut hidden aux éléments sélectionnés + +Returns **this** Chainage + +### delReadOnly + +Supprime l'attribut readonly aux éléments sélectionnés + +Returns **this** Chainage + +### delDisabled + +Supprime l'attribut disabled aux éléments sélectionnés + +Returns **this** Chainage + +### toggleHidden + +switche l'attribut hidden des éléments sélectionnés + +Returns **this** Chainage + +### toggleReadOnly + +switche l'attribut readonly des éléments sélectionnés + +Returns **this** Chainage + +### toggleDisabled + +switche l'attribut disabled des éléments sélectionnés + +Returns **this** Chainage + +### on + +Ajout d'un gestionnaire d'événement aux éléments sélectionnés + +#### Parameters + +- `type` **[String][36]** Nom de l'événement +- `callback` **[Function][38]** Gestionnaire de l'événement +- `useCapture` **[Boolean][39]** Propagation de l'événement + +### onClick + +Ajout d'un gestionnaire d'événement 'click' pour les éléments sélectionnés + +#### Parameters + +- `callback` **[Function][38]** Gestionnaire de l'événement +- `useCapture` **[Boolean][39]** Propagation de l'événement + +### found + +Retourne si un élément a été trouvé + +Returns **[Boolean][39]** l'élément du DOM trouvé + +### first + +Retourne le premier élément trouvé + +Returns **[HTMLElement][37]** l'élément du DOM trouvé + +### last + +Retourne le dernier élément trouvé + +Returns **[HTMLElement][37]** L'élément du DOM trouvé + +## gsd + +Instantiation d'un nouveau constructeur + +### Parameters + +- `selector` **[String][36]** Sélecteur utilisé +- `root` +- `scope` **[HTMLElement][37]** Racine de la recherche + +### version + +Version de la librairie + +## gsd + +Returns **any** Retour de la librairie + +### version + +Version de la librairie + +[1]: #constructor + +[2]: #parameters + +[3]: #each + +[4]: #parameters-1 + +[5]: #addclass + +[6]: #parameters-2 + +[7]: #removeclass + +[8]: #parameters-3 + +[9]: #replaceclass + +[10]: #parameters-4 + +[11]: #setattr + +[12]: #parameters-5 + +[13]: #delattr + +[14]: #parameters-6 + +[15]: #sethidden + +[16]: #setreadonly + +[17]: #setdisabled + +[18]: #delhidden + +[19]: #delreadonly + +[20]: #deldisabled + +[21]: #togglehidden + +[22]: #togglereadonly + +[23]: #toggledisabled + +[24]: #on + +[25]: #parameters-7 + +[26]: #onclick + +[27]: #parameters-8 + +[28]: #found + +[29]: #first + +[30]: #last + +[31]: #gsd + +[32]: #parameters-9 + +[33]: #version + +[34]: #gsd-1 + +[35]: #version-1 + +[36]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String + +[37]: https://developer.mozilla.org/docs/Web/HTML/Element + +[38]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function + +[39]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean