diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md index 51d485b..57d889b 100644 --- a/DOCUMENTATION.md +++ b/DOCUMENTATION.md @@ -4,40 +4,39 @@ - [Constructor][1] - [Parameters][2] - - [Examples][3] - - [each][4] - - [Parameters][5] - - [addClass][6] - - [Parameters][7] - - [removeClass][8] - - [Parameters][9] - - [replaceClass][10] - - [Parameters][11] - - [setAttr][12] - - [Parameters][13] - - [delAttr][14] - - [Parameters][15] - - [setHidden][16] - - [setReadOnly][17] - - [setDisabled][18] - - [delHidden][19] - - [delReadOnly][20] - - [delDisabled][21] - - [toggleHidden][22] - - [toggleReadOnly][23] - - [toggleDisabled][24] - - [on][25] - - [Parameters][26] - - [onClick][27] - - [Parameters][28] - - [found][29] - - [first][30] - - [last][31] -- [gsd][32] - - [Parameters][33] - - [version][34] -- [gsd][35] - - [version][36] + - [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 @@ -45,14 +44,8 @@ Création du constructeur ### Parameters -- `selector` **[String][37]** Sélecteur utilisé -- `scope` **[HTMLElement][38]** Racine de la recherche - -### Examples - -```javascript -let element = $_("a.link", "div#main"); -``` +- `selector` **[String][36]** Sélecteur utilisé +- `scope` **[HTMLElement][37]** Racine de la recherche ### each @@ -60,7 +53,7 @@ Application d'une fonction sur chacun des éléments #### Parameters -- `callback` **[Function][39]** La fonction de rappel +- `callback` **[Function][38]** La fonction de rappel ### addClass @@ -68,7 +61,7 @@ Ajout d'une classe aux éléments sélectionnés #### Parameters -- `className` **[String][37]** Le nom de la classe à ajouter +- `className` **[String][36]** Le nom de la classe à ajouter Returns **this** Chainage @@ -78,7 +71,7 @@ Ajout d'une classe aux éléments sélectionnés #### Parameters -- `className` **[String][37]** Le nom de la classe à ajouter +- `className` **[String][36]** Le nom de la classe à ajouter Returns **this** Chainage @@ -88,8 +81,8 @@ Remplace une classe par une autre dans les éléments sélectionnés #### Parameters -- `oldClass` **[String][37]** Nom de la classe à remplacer -- `newClass` **[String][37]** Nom de la classe de remplacement +- `oldClass` **[String][36]** Nom de la classe à remplacer +- `newClass` **[String][36]** Nom de la classe de remplacement Returns **this** Chainage @@ -99,8 +92,8 @@ Définit un attribut et sa valeur #### Parameters -- `attr` **[String][37]** Nom de l'attribut -- `value` **[String][37]** Valeur de l'attribut +- `attr` **[String][36]** Nom de l'attribut +- `value` **[String][36]** Valeur de l'attribut Returns **this** Chainage @@ -110,7 +103,7 @@ Supprime un attribut dans les éléments sélectionnés #### Parameters -- `attr` **[String][37]** Nom de l'attribut à supprimer +- `attr` **[String][36]** Nom de l'attribut à supprimer Returns **this** Chainage @@ -174,9 +167,9 @@ Ajout d'un gestionnaire d'événement aux éléments sélectionnés #### Parameters -- `type` **[String][37]** Nom de l'événement -- `callback` **[Function][39]** Gestionnaire de l'événement -- `useCapture` **[Boolean][40]** Propagation de l'événement +- `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 @@ -184,26 +177,26 @@ Ajout d'un gestionnaire d'événement 'click' pour les éléments sélectionnés #### Parameters -- `callback` **[Function][39]** Gestionnaire de l'événement -- `useCapture` **[Boolean][40]** Propagation de l'événement +- `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][40]** l'élément du DOM trouvé +Returns **[Boolean][39]** l'élément du DOM trouvé ### first Retourne le premier élément trouvé -Returns **[HTMLElement][38]** l'élément du DOM trouvé +Returns **[HTMLElement][37]** l'élément du DOM trouvé ### last Retourne le dernier élément trouvé -Returns **[HTMLElement][38]** L'élément du DOM trouvé +Returns **[HTMLElement][37]** L'élément du DOM trouvé ## gsd @@ -211,9 +204,9 @@ Instantiation d'un nouveau constructeur ### Parameters -- `selector` **[String][37]** Sélecteur utilisé +- `selector` **[String][36]** Sélecteur utilisé - `root` -- `scope` **[HTMLElement][38]** Racine de la recherche +- `scope` **[HTMLElement][37]** Racine de la recherche ### version @@ -231,78 +224,76 @@ Version de la librairie [2]: #parameters -[3]: #examples +[3]: #each -[4]: #each +[4]: #parameters-1 -[5]: #parameters-1 +[5]: #addclass -[6]: #addclass +[6]: #parameters-2 -[7]: #parameters-2 +[7]: #removeclass -[8]: #removeclass +[8]: #parameters-3 -[9]: #parameters-3 +[9]: #replaceclass -[10]: #replaceclass +[10]: #parameters-4 -[11]: #parameters-4 +[11]: #setattr -[12]: #setattr +[12]: #parameters-5 -[13]: #parameters-5 +[13]: #delattr -[14]: #delattr +[14]: #parameters-6 -[15]: #parameters-6 +[15]: #sethidden -[16]: #sethidden +[16]: #setreadonly -[17]: #setreadonly +[17]: #setdisabled -[18]: #setdisabled +[18]: #delhidden -[19]: #delhidden +[19]: #delreadonly -[20]: #delreadonly +[20]: #deldisabled -[21]: #deldisabled +[21]: #togglehidden -[22]: #togglehidden +[22]: #togglereadonly -[23]: #togglereadonly +[23]: #toggledisabled -[24]: #toggledisabled +[24]: #on -[25]: #on +[25]: #parameters-7 -[26]: #parameters-7 +[26]: #onclick -[27]: #onclick +[27]: #parameters-8 -[28]: #parameters-8 +[28]: #found -[29]: #found +[29]: #first -[30]: #first +[30]: #last -[31]: #last +[31]: #gsd -[32]: #gsd +[32]: #parameters-9 -[33]: #parameters-9 +[33]: #version -[34]: #version +[34]: #gsd-1 -[35]: #gsd-1 +[35]: #version-1 -[36]: #version-1 +[36]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String -[37]: 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/HTML/Element +[38]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function -[39]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function - -[40]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean +[39]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean