Files
GSDom/DOCUMENTATION.md

309 lines
5.3 KiB
Markdown

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
### Table of Contents
- [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]
## Constructor
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");
```
### each
Application d'une fonction sur chacun des éléments
#### Parameters
- `callback` **[Function][39]** La fonction de rappel
### addClass
Ajout d'une classe aux éléments sélectionnés
#### Parameters
- `className` **[String][37]** Le nom de la classe à ajouter
Returns **this** Chainage
### removeClass
Ajout d'une classe aux éléments sélectionnés
#### Parameters
- `className` **[String][37]** 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][37]** Nom de la classe à remplacer
- `newClass` **[String][37]** Nom de la classe de remplacement
Returns **this** Chainage
### setAttr
Définit un attribut et sa valeur
#### Parameters
- `attr` **[String][37]** Nom de l'attribut
- `value` **[String][37]** Valeur de l'attribut
Returns **this** Chainage
### delAttr
Supprime un attribut dans les éléments sélectionnés
#### Parameters
- `attr` **[String][37]** 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][37]** Nom de l'événement
- `callback` **[Function][39]** Gestionnaire de l'événement
- `useCapture` **[Boolean][40]** Propagation de l'événement
### onClick
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
### found
Retourne si un élément a été trouvé
Returns **[Boolean][40]** l'élément du DOM trouvé
### first
Retourne le premier élément trouvé
Returns **[HTMLElement][38]** l'élément du DOM trouvé
### last
Retourne le dernier élément trouvé
Returns **[HTMLElement][38]** L'élément du DOM trouvé
## gsd
Instantiation d'un nouveau constructeur
### Parameters
- `selector` **[String][37]** Sélecteur utilisé
- `root`
- `scope` **[HTMLElement][38]** 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]: #examples
[4]: #each
[5]: #parameters-1
[6]: #addclass
[7]: #parameters-2
[8]: #removeclass
[9]: #parameters-3
[10]: #replaceclass
[11]: #parameters-4
[12]: #setattr
[13]: #parameters-5
[14]: #delattr
[15]: #parameters-6
[16]: #sethidden
[17]: #setreadonly
[18]: #setdisabled
[19]: #delhidden
[20]: #delreadonly
[21]: #deldisabled
[22]: #togglehidden
[23]: #togglereadonly
[24]: #toggledisabled
[25]: #on
[26]: #parameters-7
[27]: #onclick
[28]: #parameters-8
[29]: #found
[30]: #first
[31]: #last
[32]: #gsd
[33]: #parameters-9
[34]: #version
[35]: #gsd-1
[36]: #version-1
[37]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
[38]: https://developer.mozilla.org/docs/Web/HTML/Element
[39]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
[40]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean