Sebastien/GSDom
1
1
Fork 0
Code Issues Pull Requests Projects Releases 3 Wiki Activity

Mise à jour de la documentation

Browse Source
This commit is contained in:
Sébastien G.
2022-01-03 22:54:01 +01:00
parent 1cd690ef60
commit 4512c40a97
3 changed files with 160 additions and 93 deletions
Download Patch File Download Diff File Expand all files Collapse all files

226
DOCUMENTATION.md
View File

@@ -4,39 +4,44 @@
- [Constructor][1]
- [Parameters][2]
- [each][3]
- [Parameters][4]
- [addClass][5]
- [Parameters][6]
- [removeClass][7]
- [Examples][3]
- [each][4]
- [Parameters][5]
- [Examples][6]
- [addClass][7]
- [Parameters][8]
- [replaceClass][9]
- [Parameters][10]
- [setAttr][11]
- [Parameters][12]
- [delAttr][13]
- [Examples][9]
- [removeClass][10]
- [Parameters][11]
- [Examples][12]
- [replaceClass][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]
- [Examples][15]
- [setAttr][16]
- [Parameters][17]
- [delAttr][18]
- [Parameters][19]
- [setHidden][20]
- [setReadOnly][21]
- [setDisabled][22]
- [delHidden][23]
- [delReadOnly][24]
- [delDisabled][25]
- [toggleHidden][26]
- [toggleReadOnly][27]
- [toggleDisabled][28]
- [on][29]
- [Parameters][30]
- [onClick][31]
- [Parameters][32]
- [found][33]
- [first][34]
- [last][35]
- [gsd][36]
- [Parameters][37]
- [version][38]
- [gsd][39]
- [version][40]
## Constructor
@@ -44,8 +49,15 @@ Création du constructeur
### Parameters
- `selector` **[String][36]** Sélecteur utilisé
- `scope` **[HTMLElement][37]** Racine de la recherche
- `selector` **[String][41]** Sélecteur utilisé
- `scope` **[HTMLElement][42]** Racine de la recherche
### Examples
```javascript
# Tous les a class link contenu dans un div id main
$_("a.link", "div#main");
```
### each
@@ -53,7 +65,15 @@ Application d'une fonction sur chacun des éléments
#### Parameters
- `callback` **[Function][38]** La fonction de rappel
- `callback` **[Function][43]** La fonction de rappel
#### Examples
```javascript
$_(".class").each((item, index) => {
// Do something with item et index
});
```
### addClass
@@ -61,17 +81,29 @@ Ajout d'une classe aux éléments sélectionnés
#### Parameters
- `className` **[String][36]** Le nom de la classe à ajouter
- `className` **[String][41]** Le nom de la classe à ajouter
#### Examples
```javascript
$_("p","div#main").addClass("myClass");
```
Returns **this** Chainage
### removeClass
Ajout d'une classe aux éléments sélectionnés
Suppression d'une classe aux éléments sélectionnés
#### Parameters
- `className` **[String][36]** Le nom de la classe à ajouter
- `className` **[String][41]** Le nom de la classe à ajouter
#### Examples
```javascript
$_("p","div#main").removeClass("myClass");
```
Returns **this** Chainage
@@ -81,8 +113,14 @@ 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
- `oldClass` **[String][41]** Nom de la classe à remplacer
- `newClass` **[String][41]** Nom de la classe de remplacement
#### Examples
```javascript
$_("p","div#main").replaceClass("myOldClass", "myNewClass");
```
Returns **this** Chainage
@@ -92,8 +130,8 @@ Définit un attribut et sa valeur
#### Parameters
- `attr` **[String][36]** Nom de l'attribut
- `value` **[String][36]** Valeur de l'attribut
- `attr` **[String][41]** Nom de l'attribut
- `value` **[String][41]** Valeur de l'attribut
Returns **this** Chainage
@@ -103,7 +141,7 @@ Supprime un attribut dans les éléments sélectionnés
#### Parameters
- `attr` **[String][36]** Nom de l'attribut à supprimer
- `attr` **[String][41]** Nom de l'attribut à supprimer
Returns **this** Chainage
@@ -167,9 +205,9 @@ 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
- `type` **[String][41]** Nom de l'événement
- `callback` **[Function][43]** Gestionnaire de l'événement
- `useCapture` **[Boolean][44]** Propagation de l'événement
### onClick
@@ -177,26 +215,26 @@ 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
- `callback` **[Function][43]** Gestionnaire de l'événement
- `useCapture` **[Boolean][44]** Propagation de l'événement
### found
Retourne si un élément a été trouvé
Returns **[Boolean][39]** l'élément du DOM trouvé
Returns **[Boolean][44]** l'élément du DOM trouvé
### first
Retourne le premier élément trouvé
Returns **[HTMLElement][37]** l'élément du DOM trouvé
Returns **[HTMLElement][42]** l'élément du DOM trouvé
### last
Retourne le dernier élément trouvé
Returns **[HTMLElement][37]** L'élément du DOM trouvé
Returns **[HTMLElement][42]** L'élément du DOM trouvé
## gsd
@@ -204,9 +242,9 @@ Instantiation d'un nouveau constructeur
### Parameters
- `selector` **[String][36]** Sélecteur utilisé
- `selector` **[String][41]** Sélecteur utilisé
- `root`
- `scope` **[HTMLElement][37]** Racine de la recherche
- `scope` **[HTMLElement][42]** Racine de la recherche
### version
@@ -224,76 +262,86 @@ Version de la librairie
[2]: #parameters
[3]: #each
[3]: #examples
[4]: #parameters-1
[4]: #each
[5]: #addclass
[5]: #parameters-1
[6]: #parameters-2
[6]: #examples-1
[7]: #removeclass
[7]: #addclass
[8]: #parameters-3
[8]: #parameters-2
[9]: #replaceclass
[9]: #examples-2
[10]: #parameters-4
[10]: #removeclass
[11]: #setattr
[11]: #parameters-3
[12]: #parameters-5
[12]: #examples-3
[13]: #delattr
[13]: #replaceclass
[14]: #parameters-6
[14]: #parameters-4
[15]: #sethidden
[15]: #examples-4
[16]: #setreadonly
[16]: #setattr
[17]: #setdisabled
[17]: #parameters-5
[18]: #delhidden
[18]: #delattr
[19]: #delreadonly
[19]: #parameters-6
[20]: #deldisabled
[20]: #sethidden
[21]: #togglehidden
[21]: #setreadonly
[22]: #togglereadonly
[22]: #setdisabled
[23]: #toggledisabled
[23]: #delhidden
[24]: #on
[24]: #delreadonly
[25]: #parameters-7
[25]: #deldisabled
[26]: #onclick
[26]: #togglehidden
[27]: #parameters-8
[27]: #togglereadonly
[28]: #found
[28]: #toggledisabled
[29]: #first
[29]: #on
[30]: #last
[30]: #parameters-7
[31]: #gsd
[31]: #onclick
[32]: #parameters-9
[32]: #parameters-8
[33]: #version
[33]: #found
[34]: #gsd-1
[34]: #first
[35]: #version-1
[35]: #last
[36]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
[36]: #gsd
[37]: https://developer.mozilla.org/docs/Web/HTML/Element
[37]: #parameters-9
[38]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
[38]: #version
[39]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
[39]: #gsd-1
[40]: #version-1
[41]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
[42]: https://developer.mozilla.org/docs/Web/HTML/Element
[43]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
[44]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean