diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md index 0d8aa50..c18d71c 100644 --- a/DOCUMENTATION.md +++ b/DOCUMENTATION.md @@ -2,62 +2,62 @@ ### Table of Contents -- [Constructor][1] - - [Parameters][2] - - [Examples][3] - - [each][4] - - [Parameters][5] - - [Examples][6] - - [addClass][7] - - [Parameters][8] - - [Examples][9] - - [removeClass][10] - - [Parameters][11] - - [Examples][12] - - [replaceClass][13] - - [Parameters][14] - - [Examples][15] - - [setAttr][16] - - [Parameters][17] - - [Examples][18] - - [delAttr][19] - - [Parameters][20] - - [Examples][21] - - [setHidden][22] - - [Examples][23] - - [setReadOnly][24] - - [Examples][25] - - [setDisabled][26] - - [Examples][27] - - [delHidden][28] - - [Examples][29] - - [delReadOnly][30] - - [Examples][31] - - [delDisabled][32] - - [Examples][33] - - [toggleHidden][34] - - [Examples][35] - - [toggleReadOnly][36] - - [Examples][37] - - [toggleDisabled][38] - - [Examples][39] - - [on][40] - - [Parameters][41] - - [Examples][42] - - [onClick][43] - - [Parameters][44] - - [Examples][45] - - [found][46] - - [Examples][47] - - [first][48] - - [Examples][49] - - [last][50] - - [Examples][51] -- [gsd][52] - - [Parameters][53] - - [version][54] -- [gsd][55] - - [version][56] +* [Constructor][1] + * [Parameters][2] + * [Examples][3] + * [each][4] + * [Parameters][5] + * [Examples][6] + * [addClass][7] + * [Parameters][8] + * [Examples][9] + * [removeClass][10] + * [Parameters][11] + * [Examples][12] + * [replaceClass][13] + * [Parameters][14] + * [Examples][15] + * [setAttr][16] + * [Parameters][17] + * [Examples][18] + * [delAttr][19] + * [Parameters][20] + * [Examples][21] + * [setHidden][22] + * [Examples][23] + * [setReadOnly][24] + * [Examples][25] + * [setDisabled][26] + * [Examples][27] + * [delHidden][28] + * [Examples][29] + * [delReadOnly][30] + * [Examples][31] + * [delDisabled][32] + * [Examples][33] + * [toggleHidden][34] + * [Examples][35] + * [toggleReadOnly][36] + * [Examples][37] + * [toggleDisabled][38] + * [Examples][39] + * [on][40] + * [Parameters][41] + * [Examples][42] + * [onClick][43] + * [Parameters][44] + * [Examples][45] + * [found][46] + * [Examples][47] + * [first][48] + * [Examples][49] + * [last][50] + * [Examples][51] +* [gsd][52] + * [Parameters][53] + * [version][54] +* [gsd][55] + * [version][56] ## Constructor @@ -65,13 +65,13 @@ Création du constructeur ### Parameters -- `selector` **[String][57]** Sélecteur utilisé -- `scope` **[HTMLElement][58]** Racine de la recherche +* `selector` **[String][57]** Sélecteur utilisé +* `scope` **[HTMLElement][58]** Racine de la recherche ### Examples ```javascript -# Tous les a class link contenu dans un div id main +# Tous les `a` class `link` contenu dans un `div` id `main` $_("a.link", "div#main"); ``` @@ -81,7 +81,7 @@ Application d'une fonction sur chacun des éléments #### Parameters -- `callback` **[Function][59]** La fonction de rappel +* `callback` **[Function][59]** La fonction de rappel #### Examples @@ -97,7 +97,7 @@ Ajout d'une classe aux éléments sélectionnés #### Parameters -- `className` **[String][57]** Le nom de la classe à ajouter +* `className` **[String][57]** Le nom de la classe à ajouter #### Examples @@ -113,7 +113,7 @@ Suppression d'une classe aux éléments sélectionnés #### Parameters -- `className` **[String][57]** Le nom de la classe à ajouter +* `className` **[String][57]** Le nom de la classe à ajouter #### Examples @@ -129,8 +129,8 @@ Remplace une classe par une autre dans les éléments sélectionnés #### Parameters -- `oldClass` **[String][57]** Nom de la classe à remplacer -- `newClass` **[String][57]** Nom de la classe de remplacement +* `oldClass` **[String][57]** Nom de la classe à remplacer +* `newClass` **[String][57]** Nom de la classe de remplacement #### Examples @@ -146,8 +146,8 @@ Définit un attribut et sa valeur #### Parameters -- `attr` **[String][57]** Nom de l'attribut -- `value` **[String][57]** Valeur de l'attribut +* `attr` **[String][57]** Nom de l'attribut +* `value` **[String][57]** Valeur de l'attribut #### Examples @@ -163,7 +163,7 @@ Supprime un attribut dans les éléments sélectionnés #### Parameters -- `attr` **[String][57]** Nom de l'attribut à supprimer +* `attr` **[String][57]** Nom de l'attribut à supprimer #### Examples @@ -287,9 +287,9 @@ Ajout d'un gestionnaire d'événement aux éléments sélectionnés #### Parameters -- `type` **[String][57]** Nom de l'événement -- `callback` **[Function][59]** Gestionnaire de l'événement -- `useCapture` **[Boolean][60]** Propagation de l'événement +* `type` **[String][57]** Nom de l'événement +* `callback` **[Function][59]** Gestionnaire de l'événement +* `useCapture` **[Boolean][60]** Propagation de l'événement #### Examples @@ -305,8 +305,8 @@ Ajout d'un gestionnaire d'événement 'click' pour les éléments sélectionnés #### Parameters -- `callback` **[Function][59]** Gestionnaire de l'événement -- `useCapture` **[Boolean][60]** Propagation de l'événement +* `callback` **[Function][59]** Gestionnaire de l'événement +* `useCapture` **[Boolean][60]** Propagation de l'événement #### Examples @@ -326,7 +326,7 @@ Retourne si un élément a été trouvé let found = $_("#main").found(); ``` -Returns **[Boolean][60]** l'élément du DOM trouvé +Returns **[Boolean][60]** `true` si un élément au moins du DOM trouvé. `false` sinon ### first @@ -358,9 +358,9 @@ Instantiation d'un nouveau constructeur ### Parameters -- `selector` **[String][57]** Sélecteur utilisé -- `root` -- `scope` **[HTMLElement][58]** Racine de la recherche +* `selector` **[String][57]** Sélecteur utilisé +* `root` +* `scope` **[HTMLElement][58]** Racine de la recherche ### version diff --git a/dist/gsdom.min.js b/dist/gsdom.min.js index 4ec7fcc..8dbb91d 100644 --- a/dist/gsdom.min.js +++ b/dist/gsdom.min.js @@ -1 +1 @@ -window.$_=(()=>{"use strict";let t=function(t,e){if(t)if("document"===t)this.elems=[document];else if("window"===t)this.elems=[window];else{let i=e||document;this.elems=i.querySelectorAll(t)}};t.prototype.each=function(t){if(t&&"function"==typeof t)return this.elems.forEach((e,i)=>{t(e,i)}),this},t.prototype.addClass=function(t){return this.each(e=>{e.classList.add(t)}),this},t.prototype.removeClass=function(t){return this.each(e=>{e.classList.remove(t)}),this},t.prototype.replaceClass=function(t,e){return this.each(i=>{i.classList.replace(t,e)}),this},t.prototype.setAttr=function(t,e){return this.each(i=>{i.setAttribute(t,e)}),this},t.prototype.delAttr=function(t){return this.each(e=>{e.removeAttribute(t)}),this},t.prototype.setHidden=function(){return this.setAttr("hidden",""),this},t.prototype.setReadOnly=function(){return this.setAttr("readonly",""),this},t.prototype.setDisabled=function(){return this.setAttr("disabled",""),this},t.prototype.delHidden=function(){return this.delAttr("hidden"),this},t.prototype.delReadOnly=function(){return this.delAttr("readonly"),this},t.prototype.delDisabled=function(){return this.delAttr("disabled"),this},t.prototype.toggleHidden=function(){return this.each(t=>{t.hasAttribute("hidden")?t.removeAttribute("hidden"):t.setAttribute("hidden","")}),this},t.prototype.toggleReadOnly=function(){return this.each(t=>{t.hasAttribute("readonly")?t.removeAttribute("readonly"):t.setAttribute("readonly","")}),this},t.prototype.toggleDisabled=function(){return this.each(t=>{t.hasAttribute("disabled")?t.removeAttribute("disabled"):t.setAttribute("disabled","")}),this},t.prototype.on=function(t,e,i){return this.each(r=>{r.removeEventListener(t,e,i||!1),r.addEventListener(t,(t,i)=>{e(t,i)},i||!1)}),this},t.prototype.onClick=function(t,e){return this.on("click",t,e||!1),this},t.prototype.found=function(){return this.elems.length>0},t.prototype.first=function(){return!!this.found()&&this.elems[0]},t.prototype.last=function(){return!!this.found()&&this.elems[this.elems.length-1]};let e=(e,i)=>new t(e,i);return e.version="GSD 1.1.1 by Séb",e})(); \ No newline at end of file +window.$_=(()=>{"use strict";let t=function(t,e){if(t)if("document"===t)this.elems=[document];else if("window"===t)this.elems=[window];else{let i=e||document;this.elems=i.querySelectorAll(t)}};t.prototype.each=function(t){if(t&&"function"==typeof t)return this.elems.forEach(((e,i)=>{t(e,i)})),this},t.prototype.addClass=function(t){return this.each((e=>{e.classList.add(t)})),this},t.prototype.removeClass=function(t){return this.each((e=>{e.classList.remove(t)})),this},t.prototype.replaceClass=function(t,e){return this.each((i=>{i.classList.replace(t,e)})),this},t.prototype.setAttr=function(t,e){return this.each((i=>{i.setAttribute(t,e)})),this},t.prototype.delAttr=function(t){return this.each((e=>{e.removeAttribute(t)})),this},t.prototype.setHidden=function(){return this.setAttr("hidden",""),this},t.prototype.setReadOnly=function(){return this.setAttr("readonly",""),this},t.prototype.setDisabled=function(){return this.setAttr("disabled",""),this},t.prototype.delHidden=function(){return this.delAttr("hidden"),this},t.prototype.delReadOnly=function(){return this.delAttr("readonly"),this},t.prototype.delDisabled=function(){return this.delAttr("disabled"),this},t.prototype.toggleHidden=function(){return this.each((t=>{t.hasAttribute("hidden")?t.removeAttribute("hidden"):t.setAttribute("hidden","")})),this},t.prototype.toggleReadOnly=function(){return this.each((t=>{t.hasAttribute("readonly")?t.removeAttribute("readonly"):t.setAttribute("readonly","")})),this},t.prototype.toggleDisabled=function(){return this.each((t=>{t.hasAttribute("disabled")?t.removeAttribute("disabled"):t.setAttribute("disabled","")})),this},t.prototype.on=function(t,e,i){return this.each((r=>{r.removeEventListener(t,e,i||!1),r.addEventListener(t,((t,i)=>{e(t,i)}),i||!1)})),this},t.prototype.onClick=function(t,e){return this.on("click",t,e||!1),this},t.prototype.found=function(){return this.elems.length>0},t.prototype.first=function(){return!!this.found()&&this.elems[0]},t.prototype.last=function(){return!!this.found()&&this.elems[this.elems.length-1]};let e=(e,i)=>new t(e,i);return e.version="GSD 1.1.1 by Séb",e})(); \ No newline at end of file diff --git a/src/gsdom.js b/src/gsdom.js index c5e8db4..c09e8b2 100644 --- a/src/gsdom.js +++ b/src/gsdom.js @@ -4,7 +4,7 @@ window.$_ = (() => { * Création du constructeur * * @example - * # Tous les a class link contenu dans un div id main + * # Tous les `a` class `link` contenu dans un `div` id `main` * $_("a.link", "div#main"); * * @param {String} selector Sélecteur utilisé @@ -286,7 +286,7 @@ window.$_ = (() => { * @example * let found = $_("#main").found(); * - * @returns {Boolean} l'élément du DOM trouvé + * @returns {Boolean} `true` si un élément au moins du DOM trouvé. `false` sinon */ Constructor.prototype.found = function () { return this.elems.length > 0;