Mise à jour de la documentation

This commit is contained in:
2022-01-03 22:54:01 +01:00
parent 1cd690ef60
commit 4512c40a97
3 changed files with 160 additions and 93 deletions

View File

@@ -4,7 +4,8 @@ window.$_ = (() => {
* Création du constructeur
*
* @example
* let element = $_("a.link", "div#main");
* # Tous les a class link contenu dans un div id main
* $_("a.link", "div#main");
*
* @param {String} selector Sélecteur utilisé
* @param {HTMLElement} scope Racine de la recherche
@@ -24,6 +25,12 @@ window.$_ = (() => {
};
/**
* Application d'une fonction sur chacun des éléments
*
* @example
* $_(".class").each((item, index) => {
* // Do something with item et index
* });
*
* @param {Function} callback La fonction de rappel
*/
Constructor.prototype.each = function (callback) {
@@ -37,6 +44,10 @@ window.$_ = (() => {
};
/**
* Ajout d'une classe aux éléments sélectionnés
*
* @example
* $_("p","div#main").addClass("myClass");
*
* @param {String} className Le nom de la classe à ajouter
* @returns {this} Chainage
*/
@@ -47,7 +58,11 @@ window.$_ = (() => {
return this;
};
/**
* Ajout d'une classe aux éléments sélectionnés
* Suppression d'une classe aux éléments sélectionnés
*
* @example
* $_("p","div#main").removeClass("myClass");
*
* @param {String} className Le nom de la classe à ajouter
* @returns {this} Chainage
*/
@@ -59,6 +74,10 @@ window.$_ = (() => {
};
/**
* Remplace une classe par une autre dans les éléments sélectionnés
*
* @example
* $_("p","div#main").replaceClass("myOldClass", "myNewClass");
*
* @param {String} oldClass Nom de la classe à remplacer
* @param {String} newClass Nom de la classe de remplacement
* @returns {this} Chainage
@@ -238,7 +257,7 @@ window.$_ = (() => {
/**
* Version de la librairie
*/
gsd.version = 'GSD 1.1.0 by Séb';
gsd.version = 'GSD 1.1.1 by Séb';
/**
* @return Retour de la librairie
*/