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

Compilation de la doc et du fichier min

Browse Source
This commit is contained in:
Sébastien G.
2022-01-06 09:59:43 +01:00
parent cee3d2328b
commit b41c2c2065
2 changed files with 140 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files

188
DOCUMENTATION.md
View File

@@ -57,10 +57,19 @@
* [last][53]
* [Parameters][54]
* [Examples][55]
* [eachCallback][56]
* [Parameters][57]
* [evtCallback][58]
* [Parameters][59]
* [items][56]
* [Examples][57]
* [count][58]
* [Examples][59]
* [itemAtIndex][60]
* [Parameters][61]
* [Examples][62]
* [version][63]
* [Parameters][64]
* [eachCallback][65]
* [Parameters][66]
* [evtCallback][67]
* [Parameters][68]
## GSDom
@@ -68,13 +77,13 @@ La classe GSDom est une classe écrite en pur Javascript qui permet de simplifie
### Parameters
* `selector` **([String][60] | [HTMLElement][61])** Sélecteur utilisé ou un élément du DOM (scope est alors ignoré)
* `scope` **([String][60] | [HTMLElement][61])** Sélecteur utilisé (le 1er élément trouvé est utilisé) ou un élément du DOM (optional, default `document`)
* `selector` **([String][69] | [HTMLElement][70])** Sélecteur utilisé ou un élément du DOM (scope est alors ignoré)
* `scope` **([String][69] | [HTMLElement][70])** Sélecteur utilisé (le 1er élément trouvé est utilisé) ou un élément du DOM (optional, default `document`)
### Examples
```javascript
// Ajout d'une classe `my_class` à tous lel `a`
// Ajout d'une classe `my_class` à tous les `a`
$_("a").addClass("my_class");
```
@@ -101,7 +110,7 @@ Parcours de tous les éléments sélectionnés
#### Parameters
* `callback` **[eachCallback][62]** La fonction de rappel
* `callback` **[eachCallback][71]** La fonction de rappel
#### Examples
@@ -118,7 +127,7 @@ Ajout d'une classe aux éléments sélectionnés
#### Parameters
* `className` **[String][60]** Le nom de la classe à ajouter
* `className` **[String][69]** Le nom de la classe à ajouter
#### Examples
@@ -134,7 +143,7 @@ Suppression d'une classe aux éléments sélectionnés
#### Parameters
* `className` **[String][60]** Le nom de la classe à ajouter
* `className` **[String][69]** Le nom de la classe à ajouter
#### Examples
@@ -162,8 +171,8 @@ Remplace une classe par une autre parmi les éléments sélectionnés
#### Parameters
* `oldClass` **[String][60]** Nom de la classe à remplacer
* `newClass` **[String][60]** Nom de la classe de remplacement
* `oldClass` **[String][69]** Nom de la classe à remplacer
* `newClass` **[String][69]** Nom de la classe de remplacement
#### Examples
@@ -179,8 +188,8 @@ Définit un attribut et sa valeur
#### Parameters
* `attr` **[String][60]** Nom de l'attribut
* `value` **[String][60]** Valeur de l'attribut
* `attr` **[String][69]** Nom de l'attribut
* `value` **[String][69]** Valeur de l'attribut
#### Examples
@@ -196,7 +205,7 @@ Supprime un attribut dans les éléments sélectionnés
#### Parameters
* `attr` **[String][60]** Nom de l'attribut à supprimer
* `attr` **[String][69]** Nom de l'attribut à supprimer
#### Examples
@@ -320,9 +329,9 @@ Ajoute un gestionnaire d'événement aux éléments sélectionnés
#### Parameters
* `type` **[String][60]** Nom de l'événement
* `callback` **[evtCallback][63]** Gestionnaire de l'événement
* `useCapture` **[Boolean][64]** Propagation de l'événement
* `type` **[String][69]** Nom de l'événement
* `callback` **[evtCallback][72]** Gestionnaire de l'événement
* `useCapture` **[Boolean][73]** Propagation de l'événement
#### Examples
@@ -338,8 +347,8 @@ Ajout d'un gestionnaire d'événement 'click' pour les éléments sélectionnés
#### Parameters
* `callback` **[evtCallback][63]** Gestionnaire de l'événement
* `useCapture` **[Boolean][64]** Propagation de l'événement
* `callback` **[evtCallback][72]** Gestionnaire de l'événement
* `useCapture` **[Boolean][73]** Propagation de l'événement
#### Examples
@@ -359,7 +368,7 @@ Retourne si un élément a été trouvé
let found = $_("#main").found();
```
Returns **[Boolean][64]** `true` si un élément au moins du DOM trouvé. `false` sinon
Returns **[Boolean][73]** `true` si un élément au moins du DOM trouvé. `false` sinon
### first
@@ -367,15 +376,19 @@ Retourne le premier élément trouvé
#### Parameters
* `isHTMLElement` **[Boolean][64]** `true` pour obtenir un élément du DOM, `false` pour un Objet GSDom (optional, default `false`)
* `isHTMLElement` **[Boolean][73]** `true` pour obtenir un élément du DOM, `false` pour un Objet GSDom (optional, default `false`)
#### Examples
```javascript
let htmlElement = $_("p.paragraphe").first();
let htmlElement = $_("p.paragraphe").first(true);
```
Returns **[HTMLElement][61]** l'élément du DOM trouvé
```javascript
$_("input.my_class").first().setDisabled();
```
Returns **[HTMLElement][70]** l'élément du DOM trouvé
### last
@@ -383,42 +396,99 @@ Retourne le dernier élément trouvé
#### Parameters
* `isHTMLElement` **[Boolean][64]** `true` pour obtenir un élément du DOM, `false` pour un Objet GSDom (optional, default `false`)
* `isHTMLElement` **[Boolean][73]** `true` pour obtenir un élément du DOM, `false` pour un Objet GSDom (optional, default `false`)
#### Examples
```javascript
let htmlElement = $_("p.paragraphe").last();
let htmlElement = $_("p.paragraphe").last(true);
```
Returns **([GSDom][65] | [HTMLElement][61])** L'élément du DOM trouvé ou un Objet GSDom correspondant pour chainage
```javascript
$_("input.my_class").last().setDisabled();
```
Returns **([GSDom][74] | [HTMLElement][70])** L'élément du DOM trouvé ou un Objet GSDom correspondant pour chainage
### items
Retourne un tableau des éléments du Dom sélectionnés
#### Examples
```javascript
let my_HTMLElements = $_("p.my_class").items();
```
Returns **[Array][75]<[HTMLElement][70]>** les éléments du DOM sélectionnés
### count
Retourne le nombre d'éléments du DOM sélectionnés
#### Examples
```javascript
let count = $_("p.my_class").count();
```
### itemAtIndex
Retourne l'élément à l'index `index` parmi les éléments sélectionnés;
#### Parameters
* `index` **[Number][76]** Index de l'élément souhaité
* `isHTMLElement` **[Boolean][73]** `true` pour obtenir un élément du DOM, `false` pour un Objet GSDom (optional, default `false`)
#### Examples
```javascript
let htmlElement = $_("p.paragraphe").itemAtIndex(2,true);
```
```javascript
$_("input.my_class").itemAtIndex(2).setDisabled();
```
Returns **([GSDom][74] | [HTMLElement][70])** L'élément du DOM trouvé ou un Objet GSDom correspondant pour chainage
### version
Retourne la version de la bibliothèque
#### Parameters
* `long` **[Boolean][73]** `true` pour obtenir la version longue
Returns **[String][69]** Le numéro de version
## eachCallback
* **See**: [#each][4]
* **See**: [each][4]
Fonction de rappel la méthode each()
Type: [Function][66]
Type: [Function][77]
### Parameters
* `element` **[HTMLElement][61]** L'élément du DOM concerné
* `index` **[number][67]** L'index de l'élément
* `element` **[HTMLElement][70]** L'élément du DOM concerné
* `index` **[number][76]** L'index de l'élément
## evtCallback
* **See**: [#on][42]
* **See**: [#onclick][45]
* **See**: [on][42]
* **See**: [onClick][45]
Fonction de rappel des méthodes on() et onClick()
Type: [Function][66]
Type: [Function][77]
### Parameters
* `evt` **[Event][68]** L'événement qui s'est produit
* `item` **[HTMLElement][61]** L'élément du DOM concerné par lévénement
* `evt` **[Event][78]** L'événement qui s'est produit
* `item` **[HTMLElement][70]** L'élément du DOM concerné par lévénement
[1]: #gsdom
@@ -530,28 +600,48 @@ Type: [Function][66]
[55]: #examples-21
[56]: #eachcallback
[56]: #items
[57]: #parameters-11
[57]: #examples-22
[58]: #evtcallback
[58]: #count
[59]: #parameters-12
[59]: #examples-23
[60]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
[60]: #itematindex
[61]: https://developer.mozilla.org/docs/Web/HTML/Element
[61]: #parameters-11
[62]: #eachcallback
[62]: #examples-24
[63]: #evtcallback
[63]: #version
[64]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
[64]: #parameters-12
[65]: #gsdom
[65]: #eachcallback
[66]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
[66]: #parameters-13
[67]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
[67]: #evtcallback
[68]: https://developer.mozilla.org/docs/Web/API/Event
[68]: #parameters-14
[69]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
[70]: https://developer.mozilla.org/docs/Web/HTML/Element
[71]: #eachcallback
[72]: #evtcallback
[73]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
[74]: #gsdom
[75]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
[76]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
[77]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
[78]: https://developer.mozilla.org/docs/Web/API/Event