496 lines
7.8 KiB
Markdown
496 lines
7.8 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]
|
|
- [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
|
|
|
|
Création du constructeur
|
|
|
|
### Parameters
|
|
|
|
- `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
|
|
$_("a.link", "div#main");
|
|
```
|
|
|
|
### each
|
|
|
|
Application d'une fonction sur chacun des éléments
|
|
|
|
#### Parameters
|
|
|
|
- `callback` **[Function][59]** La fonction de rappel
|
|
|
|
#### Examples
|
|
|
|
```javascript
|
|
$_(".class").each((item, index) => {
|
|
// Do something with item et index
|
|
});
|
|
```
|
|
|
|
### addClass
|
|
|
|
Ajout d'une classe aux éléments sélectionnés
|
|
|
|
#### Parameters
|
|
|
|
- `className` **[String][57]** Le nom de la classe à ajouter
|
|
|
|
#### Examples
|
|
|
|
```javascript
|
|
$_("p","div#main").addClass("myClass");
|
|
```
|
|
|
|
Returns **this** Chainage
|
|
|
|
### removeClass
|
|
|
|
Suppression d'une classe aux éléments sélectionnés
|
|
|
|
#### Parameters
|
|
|
|
- `className` **[String][57]** Le nom de la classe à ajouter
|
|
|
|
#### Examples
|
|
|
|
```javascript
|
|
$_("p","div#main").removeClass("myClass");
|
|
```
|
|
|
|
Returns **this** Chainage
|
|
|
|
### replaceClass
|
|
|
|
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
|
|
|
|
#### Examples
|
|
|
|
```javascript
|
|
$_("p","div#main").replaceClass("myOldClass", "myNewClass");
|
|
```
|
|
|
|
Returns **this** Chainage
|
|
|
|
### setAttr
|
|
|
|
Définit un attribut et sa valeur
|
|
|
|
#### Parameters
|
|
|
|
- `attr` **[String][57]** Nom de l'attribut
|
|
- `value` **[String][57]** Valeur de l'attribut
|
|
|
|
#### Examples
|
|
|
|
```javascript
|
|
$_("input.class").setAttr("readonly", "");
|
|
```
|
|
|
|
Returns **this** Chainage
|
|
|
|
### delAttr
|
|
|
|
Supprime un attribut dans les éléments sélectionnés
|
|
|
|
#### Parameters
|
|
|
|
- `attr` **[String][57]** Nom de l'attribut à supprimer
|
|
|
|
#### Examples
|
|
|
|
```javascript
|
|
$_(input.class).delAttr("readonly");
|
|
```
|
|
|
|
Returns **this** Chainage
|
|
|
|
### setHidden
|
|
|
|
Ajoute l'attribut hidden aux éléments sélectionnés
|
|
|
|
#### Examples
|
|
|
|
```javascript
|
|
$_("span.class").setHidden();
|
|
```
|
|
|
|
Returns **this** Chainage
|
|
|
|
### setReadOnly
|
|
|
|
Ajoute l'attribut readonly aux éléments sélectionnés
|
|
|
|
#### Examples
|
|
|
|
```javascript
|
|
$_("input.class").setReadOnly();
|
|
```
|
|
|
|
Returns **this** Chainage
|
|
|
|
### setDisabled
|
|
|
|
Ajoute l'attribut disabled aux éléments sélectionnés
|
|
|
|
#### Examples
|
|
|
|
```javascript
|
|
$_("input.class").setDisabled();
|
|
```
|
|
|
|
Returns **this** Chainage
|
|
|
|
### delHidden
|
|
|
|
Supprime l'attribut hidden aux éléments sélectionnés
|
|
|
|
#### Examples
|
|
|
|
```javascript
|
|
$_("span.class").delHidden();
|
|
```
|
|
|
|
Returns **this** Chainage
|
|
|
|
### delReadOnly
|
|
|
|
Supprime l'attribut readonly aux éléments sélectionnés
|
|
|
|
#### Examples
|
|
|
|
```javascript
|
|
$_("input.class").delReadOnly();
|
|
```
|
|
|
|
Returns **this** Chainage
|
|
|
|
### delDisabled
|
|
|
|
Supprime l'attribut disabled aux éléments sélectionnés
|
|
|
|
#### Examples
|
|
|
|
```javascript
|
|
$_("input.class").delDisabled();
|
|
```
|
|
|
|
Returns **this** Chainage
|
|
|
|
### toggleHidden
|
|
|
|
switche l'attribut hidden des éléments sélectionnés
|
|
|
|
#### Examples
|
|
|
|
```javascript
|
|
$_("span.class").toggleHidden();
|
|
```
|
|
|
|
Returns **this** Chainage
|
|
|
|
### toggleReadOnly
|
|
|
|
switche l'attribut readonly des éléments sélectionnés
|
|
|
|
#### Examples
|
|
|
|
```javascript
|
|
$_("input.class").toggleReadOnly();
|
|
```
|
|
|
|
Returns **this** Chainage
|
|
|
|
### toggleDisabled
|
|
|
|
switche l'attribut disabled des éléments sélectionnés
|
|
|
|
#### Examples
|
|
|
|
```javascript
|
|
$_("input.class").toggleDisabled();
|
|
```
|
|
|
|
Returns **this** Chainage
|
|
|
|
### on
|
|
|
|
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
|
|
|
|
#### Examples
|
|
|
|
```javascript
|
|
$_("button#event").on("mouseover", (evt, el) => {
|
|
// Do something with evt and el
|
|
}, false);
|
|
```
|
|
|
|
### onClick
|
|
|
|
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
|
|
|
|
#### Examples
|
|
|
|
```javascript
|
|
$_("button#event").onClick( (evt, el) => {
|
|
// Do something with evt and el
|
|
}, false);
|
|
```
|
|
|
|
### found
|
|
|
|
Retourne si un élément a été trouvé
|
|
|
|
#### Examples
|
|
|
|
```javascript
|
|
let found = $_("#main").found();
|
|
```
|
|
|
|
Returns **[Boolean][60]** l'élément du DOM trouvé
|
|
|
|
### first
|
|
|
|
Retourne le premier élément trouvé
|
|
|
|
#### Examples
|
|
|
|
```javascript
|
|
let htmlElement = $_("p.paragraphe").first();
|
|
```
|
|
|
|
Returns **[HTMLElement][58]** l'élément du DOM trouvé
|
|
|
|
### last
|
|
|
|
Retourne le dernier élément trouvé
|
|
|
|
#### Examples
|
|
|
|
```javascript
|
|
let htmlElement = $_("p.paragraphe").last();
|
|
```
|
|
|
|
Returns **[HTMLElement][58]** L'élément du DOM trouvé
|
|
|
|
## gsd
|
|
|
|
Instantiation d'un nouveau constructeur
|
|
|
|
### Parameters
|
|
|
|
- `selector` **[String][57]** Sélecteur utilisé
|
|
- `root`
|
|
- `scope` **[HTMLElement][58]** 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]: #examples-1
|
|
|
|
[7]: #addclass
|
|
|
|
[8]: #parameters-2
|
|
|
|
[9]: #examples-2
|
|
|
|
[10]: #removeclass
|
|
|
|
[11]: #parameters-3
|
|
|
|
[12]: #examples-3
|
|
|
|
[13]: #replaceclass
|
|
|
|
[14]: #parameters-4
|
|
|
|
[15]: #examples-4
|
|
|
|
[16]: #setattr
|
|
|
|
[17]: #parameters-5
|
|
|
|
[18]: #examples-5
|
|
|
|
[19]: #delattr
|
|
|
|
[20]: #parameters-6
|
|
|
|
[21]: #examples-6
|
|
|
|
[22]: #sethidden
|
|
|
|
[23]: #examples-7
|
|
|
|
[24]: #setreadonly
|
|
|
|
[25]: #examples-8
|
|
|
|
[26]: #setdisabled
|
|
|
|
[27]: #examples-9
|
|
|
|
[28]: #delhidden
|
|
|
|
[29]: #examples-10
|
|
|
|
[30]: #delreadonly
|
|
|
|
[31]: #examples-11
|
|
|
|
[32]: #deldisabled
|
|
|
|
[33]: #examples-12
|
|
|
|
[34]: #togglehidden
|
|
|
|
[35]: #examples-13
|
|
|
|
[36]: #togglereadonly
|
|
|
|
[37]: #examples-14
|
|
|
|
[38]: #toggledisabled
|
|
|
|
[39]: #examples-15
|
|
|
|
[40]: #on
|
|
|
|
[41]: #parameters-7
|
|
|
|
[42]: #examples-16
|
|
|
|
[43]: #onclick
|
|
|
|
[44]: #parameters-8
|
|
|
|
[45]: #examples-17
|
|
|
|
[46]: #found
|
|
|
|
[47]: #examples-18
|
|
|
|
[48]: #first
|
|
|
|
[49]: #examples-19
|
|
|
|
[50]: #last
|
|
|
|
[51]: #examples-20
|
|
|
|
[52]: #gsd
|
|
|
|
[53]: #parameters-9
|
|
|
|
[54]: #version
|
|
|
|
[55]: #gsd-1
|
|
|
|
[56]: #version-1
|
|
|
|
[57]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
|
|
|
|
[58]: https://developer.mozilla.org/docs/Web/HTML/Element
|
|
|
|
[59]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
|
|
|
|
[60]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
|