EventTarget.addEventListener()

La méthode addEventListener() d'EventTarget installe une fonction à appeler chaque fois que l'événement spécifié est envoyé à la cible. Les cibles courantes sont un Element, le Document lui-même et une Window, mais elle peut être tout objet prenant en charge les évènements (comme XMLHttpRequest).

addEventListener() fonctionne en ajoutant une fonction, ou un objet implémentant EventListener, à la liste des écouteurs d'évènements du type d'évènement spécifié dans la EventTarget dans laquelle il est appelé.

Syntaxe

target.addEventListener(type, écouteur [, options]);
target.addEventListener(type, écouteur [, utiliserCapture]);
target.addEventListener(type, écouteur [, utiliserCapture, veutNonFiables  ]); // Gecko/Mozilla seulement

Paramètres

type 
Une chaîne sensible à la casse représentant le type d'évènement à écouter.
écouteur
L'objet qui recevra une notification (un objet qui implémente l'interface Event) lorsqu'un évènement du type spécifié se produit. Cela doit être un objet implémentant l'interface EventListener ou une fonction JavaScript. Voir The event listener callback pour des détails sur le rappel lui-même.
options Facultatif
Un objet options spécifie les caractéristiques de l'écouteur d'évènements. Les options disponibles sont :
capture
Un Boolean indiquant que les évènements de ce type seront distribués à l'écouteur enregistré avant d'être distribués à tout EventTarget située en-dessous dans l'arborescence DOM.
once
Un Boolean indiquant que l'écouteur doit être invoqué au plus une fois après avoir été ajouté. Si true (vrai), l'écouteur sera automatiquement supprimé après son appel.
passive
Un Boolean qui, si true, indique que la fonction spécifiée par l'écouteur n'appellera jamais preventDefault(). Si un écouteur passif appelle preventDefault(), l'agent utilisateur ne fera rien d'autre que de générer un avertissement sur la console. Voir Amélioration des performances de défilement avec les écouteurs passifs pour en apprendre davantage.
mozSystemGroup
Un Boolean indiquant que l'écouteur doit être ajouté au groupe système. Disponible seulement pour le code s'exécutant dans XBL ou dans le chrome du navigateur Firefox.
utiliserCapture Facultatif
Un  Boolean indiquant si les événements de ce type seront distribués à l'écouteur enregistré avant d'être distribués à toute EventTarget (cible d'évènement) située en-dessous dans l'arborescence DOM. Les événements qui se propagent vers le haut dans l'arborescence ne déclencheront pas un écouteur indiqué comme utilisant la capture. La propagation et la capture d'événements sont deux manières de propager des événements qui se produisent dans un élément imbriqué dans un autre, lorsque les deux éléments ont enregistré un gestionnaire pour cet événement. Le mode de propagation de l'évènement détermine l'ordre dans lequel les éléments reçoivent l'événement. Voir les DOM Level 3 Events et JavaScript Event order pour une explication détaillée. Si non spécifié, useCapture a false pour valeur par défaut.

Note : pour les écouteurs attachés à la cible d'évènement, l'évènement se trouve dans la phase cible, plutôt que dans les phases de propagation et de capture. Les évènements dans la phase cible déclencheront tous les écouteurs d'un élément dans l'ordre où ils ont été enregistrés, indépendamment du paramètre useCapture.

Note : useCapture n'est pas toujours facultatif. Idéalement, vous devriez l'inclure pour une compatibilité de navigateurs la plus large possible.

veutNonFiables
Un paramètre spécifique à Firefox (Gecko). Si true, l'écouteur reçoit les événements synthétiques distribués par le contenu web (le défaut est false pour le chrome du navigateur et true pour les pages web ordinaires). Ce paramètre est utile pour le code qui se trouve dans les compléments, ainsi que pour le navigateur lui-même.

Valeur retournée

undefined

Notes d'utilisation

Le rappel de l'écouteur d'évènement

L'écouteur d'évènement peut être spécifié, soit comme une fonction de rappel, soit comme un objet qui implémente EventListener, dont la méthode handleEvent () sert de fonction de rappel.

La fonction de rappel a elle-même les mêmes paramètres et la même valeur de retour que la méthode handleEvent() ; c'est-à-dire que le rappel accepte un seul paramètre : un objet basé sur Event décrivant l'événement qui s'est produit, et il ne retourne rien.

Par exemple, un rappel de gestionnaire d'événements pouvant être utilisé pour gérer à la fois fullscreenchange et fullscreenerror peut ressembler à ceci :

function gestionnaireDEvenement(evenement) {
  if (evenement.type == fullscreenchange) {
    /* gérer un passage en plein écran */
  } else /* fullscreenerror */ {
    /* gérer une erreur de passage en plein écran */
  }
}

Détection de la prise en charge des options en toute sécurité

Dans les anciennes versions de la spécification DOM, le troisième paramètre de addEventListener() était une valeur booléenne indiquant s'il fallait ou non utiliser la capture. Au fil du temps, il est devenu clair que davantage d'options étaient nécessaires. Plutôt que d'ajouter davantage de paramètres à la fonction (ce qui complique énormément les choses lors du traitement des valeurs optionnelles), le troisième paramètre a été changé en un objet pouvant contenir diverses propriétés définissant les valeurs des options pour configurer le processus de suppression de l'écouteur d'événement.

Du fait que les navigateurs anciens (ainsi que certains navigateurs "pas si vieux") supposent toujours que le troisième paramètre est un Boolean, vous devez construire votre code de façon à gérer ce scénario intelligemment. Vous pouvez le faire en utilisant la détection de fonctionnalité pour chacune des options qui vous intéresse.

Par exemple, si vous voulez vérifier l'option passive :

var passiveSupportee = false;

try {
  var options = Object.defineProperty({}, "passive", {
    get: function() {
      passiveSupportee = true;
    }
  });

  window.addEventListener("test", options, options);
  window.removeEventListener("test", options, options);
} catch(err) {
  passiveSupportee = false;
}

Cela crée un objet options avec une fonction accesseur pour la propriété passive ; l'accesseur initialise un indicateur, passiveSupportee, à true si elle est appelée. Cela signifie que si le navigateur vérifie la valeur de la propriété passive dans l'objet options, passiveSupportee sera initialisé à true ; sinon, il restera false. Nous appelons alors addEventListener() pour installer un faux gestionnaire d'événements, en spécifiant ces options, se sorte qu'elles soient vérifiées si le navigateur reconnaît un objet comme troisième paramètre. Ensuite, nous appelons removeEventListener() pour faire le ménage après notre passage. (Notez que handleEvent() est ignoré dans les écouteurs d'événements qui ne sont pas appelés).

Vous pouvez vérifier de cette façon si une option quelconque est supportée. Ajoutez simplement un accesseur pour cette option en utilisant un code similaire à celui montré ci-dessus.

Ensuite, lorsque vous voulez créer un écouteur d'événements réel qui utilise les options en question, vous pouvez faire quelque chose comme ce qui suit :

unElement.addEventListener("mouseup", gererMouseUp, passiveSupportee
                               ? { passive: true } : false);

Ici, nous ajoutons un écouteur pour l'événement mouseup dans l'élément unElement. Pour le troisième paramètre, si passiveSupportee est true, nous spécifions un objet options avec passive initialisée à true ; sinon, nous savons que nous devons passer un Boolean, et nous passons false comme valeur du paramètre useCapture.

Si vous préférez, vous pouvez utiliser une bibliothèque tierce comme Modernizr ou Detect It pour faire ce test pour vous.

Vous pouvez en apprendre davantage dans l'article à propos des EventListenerOptions  du Groupe Web Incubator Community.

Exemples

Ajouter un écouteur simple

Cet exemple montre comment utiliser addEventListener() pour surveiller les clics de souris sur un élément.

HTML

<table id="aLExterieur">
    <tr><td id="t1">un</td></tr>
    <tr><td id="t2">deux</td></tr>
</table>

JavaScript

// Fonction pour changer le contenu de t2
function modifierTexte() {
  var t2 = document.getElementById("t2");
  if (t2.firstChild.nodeValue == "trois") {
    t2.firstChild.nodeValue = "deux";
  } else {
    t2.firstChild.nodeValue = "trois";
  }
}

// Ajouter un écouteur d'évènements à la table
var el = document.getElementById("aLExterieur");
el.addEventListener("click", modifierTexte, false);

Dans ce code, modifierTexte() est un écouteur pour les évènements click enregistré en utilisant addEventListener(). Un clic n'importe où sur la table se propagera jusqu'au gestionnaire et exécutera modifierTexte().

Résultat

Écouteur d'évènement avec une fonction anonyme

Ici, nous allons voir comment utiliser une fonction anonyme pour passer des paramètres à l'écouteur d'événements.

HTML

<table id="aLExterieur">
    <tr><td id="t1">un</td></tr>
    <tr><td id="t2">deux</td></tr>
</table>

JavaScript

// Fonction pour changer le contenu de t2
function modifierTexte(nouveau_texte) {
  var t2 = document.getElementById("t2");
  t2.firstChild.nodeValue = nouveau_texte;    
}
 
// Fonction pour ajouter un écouteur d'évènement à la table
var el = document.getElementById("aLExterieur");
el.addEventListener("click", function(){modifierTexte("quatre")}, false);

Notez que l'écouteur est une fonction anonyme encapsulant le code qui peut à son tour envoyer des paramètres à la fonction modifierTexte(), qui est responsable de la réponse effective à l'événement.

Résultat

Écouteur d'évènement avec une fonction fléchée

Cet exemple montre un écouteur d'événement simple implémenté en utilisant la notation de fonction fléchée.

HTML

<table id="aLExterieur">
    <tr><td id="t1">un</td></tr>
    <tr><td id="t2">deux</td></tr>
</table>

JavaScript

// Fonction pour changer le contenu de t2
function modifierTexte(nouveau_texte) {
  var t2 = document.getElementById("t2");
  t2.firstChild.nodeValue = nouveau_texte;    
}
 
// Ajouter un écouteur d'évènements à la table avec une fonction fléchée
var el = document.getElementById("aLExterieur");
el.addEventListener("click", () => { modifierTexte("quatre"); }, false);

Résultat

Notez que si les fonctions anonymes et fléchées sont similaires, elles ont des liaisons this différentes. Alors que les fonctions anonymes (et toutes les fonctions JavaScript traditionnelles) créent leurs propres liaisons this, les fonctions fléchées héritent la liaison this de la fonction contenante.

Cela signifie que les variables et constantes disponibles pour la fonction contenante sont aussi disponibles pour le gestionnaire d'évènements lors de l'utilisation d'une fonction fléchée.

Exemple d'utilisation des options

HTML

<div class="exterieur">
  extérieur, once & none-once
  <div class="milieu" target="_blank">
    milieu, capture & none-capture
    <a class="interieur1" href="https://www.mozilla.org" target="_blank">
      intérieur1, passive & preventDefault (ce qui n'est pas autorisé)
    </a>
    <a class="interieur2" href="https://developer.mozilla.org/" target="_blank">
      intérieur2, none-passive & preventDefault (nouvelle page non ouverte)
    </a>
  </div>
</div>

CSS

.exterieur, .milieu, .interieur1, .interieur2 {
  display: block;
  width:   520px;
  padding: 15px;
  margin:  15px;
  text-decoration: none;
}
.exterieur {
  border: 1px solid red;
  color:  red;
}
.milieu {
  border: 1px solid green;
  color:  green;
  width:  460px;
}
.interieur1, .interieur2 {
  border: 1px solid purple;
  color:  purple;
  width:  400px;
}

JavaScript

const exterieur  = document.querySelector('.exterieur');
const milieu     = document.querySelector('.milieu');
const interieur1 = document.querySelector('.interieur1');
const interieur2 = document.querySelector('.interieur2');

const capture = {
  capture : true
};
const noneCapture = {
  capture : false
};
const once = {
  once : true
};
const noneOnce = {
  once : false
};
const passive = {
  passive : true
};
const nonePassive = {
  passive : false
};

exterieur .addEventListener('click', onceHandler, once);
exterieur .addEventListener('click', noneOnceHandler, noneOnce);
milieu    .addEventListener('click', captureHandler, capture);
milieu    .addEventListener('click', noneCaptureHandler, noneCapture);
interieur1.addEventListener('click', passiveHandler, passive);
interieur2.addEventListener('click', nonePassiveHandler, nonePassive);

function onceHandler(evenement) {
  alert('exterieur, once');
}
function noneOnceHandler(evenement) {
  alert('exterieur, none-once, default');
}
function captureHandler(evenement) {
  //evenement.stopImmediatePropagation();
  alert('milieu, capture');
}
function noneCaptureHandler(evenement) {
  alert('milieu, none-capture, default');
}
function passiveHandler(evenement) {
  // Impossible d'utiliser preventDefault à l'intérieur de l'invocation d'un écouteur d'évènements passif.
  evenement.preventDefault();
  alert('interieur1, passive, nouvelle page ouverte');
}
function nonePassiveHandler(evenement) {
  evenement.preventDefault();
  //evenement.stopPropagation();
  alert('interieur2, none-passive, défaut, nouvelle page non ouverte');
}

Résultat

Cliquer les conteneurs extérieur, milieu, intérieurs respectivement pour voir comment les options fonctionnent.

Avant d'utiliser une valeur particulière dans l'objet options, c'est une bonne idée que de s'assurer que le navigateur de l'utilisateur la prend en charge, du fait qu'elles sont un ajout que tous les navigateurs n'ont pas pris en charge historiquement. Voir Safely detecting option support pour les détails.

Autres notes

Pourquoi utiliser addEventListener() ?

addEventListener est la manière d'enregistrer un écouteur d'évènements telle que spécifiée dans le DOM du W3C. Ses avantages sont les suivants :

  • Elle permet d'ajouter plus d'un seul gestionnaire pour un évènement. Cela peut s'avérer particulièrement utile pour les bibliothèques AJAX, les modules JavaScript ou tout autre sorte de code qui a besoin de fonctionner correctement avec d'autres bibliothèques/extensions.
  • Elle donne un contrôle plus fin sur la phase d'activation de l'écouteur (capture contre propagation)
  • Elle fonctionne avec tout élément DOM, pas seulement avec les éléments HTML.

L'ancienne manière alternative d'enregistrer des évènements est décrite ci-dessous.

Ajout d'un écouteur pendant la distribution d'un évènement

Si un EventListener est ajouté à une EventTarget pendant qu'elle traite un évènement, cet évènement ne déclenchera l'écouteur. Cependant, le même écouteur pourra être déclenché à une étape ultérieure du flux d'évènements, telle que la phase de propagation.

Écouteurs d'évènements identiques multiples

Si des EventListeners identiques multiples sont enregistrés sur la même EventTarget avec les mêmes paramètres, les instances dupliquées sont supprimées. Elles ne provoqueront pas un appel en double de l'EventListener, et elles n'ont pas besoin d'être enlevées avec la méthode removeEventListener().

Notez toutefois que lors de l'utilisation d'une fonction anonyme comme gestionnaire, de tels écouteurs ne seront PAS identiques, du fait que les fonctions anonymes ne sont pas identiques, même si définies en utilisant le MÊME code source inchangé, simplement appelé répétitivement, même dans une boucle.

Cependant, le fait de définir répétitivement la même fonction nommée dans de tels cas peut être davantage problématique. (Voir Problèmes de mémoire ci-dessous.)

La valeur de "this" à l'intérieur du gestionnaire

Il est souvent souhaitable de référencer l'élément sur lequel le gestionnaire d'évènements a été déclenché, comme lors de l'utilisation d'un gestionnaire générique pour un ensemble d'éléments similaires.

Lorsqu'une fonction gestionnaire est attachée à un élément en utilisant addEventListener(), la valeur de this à l'intérieur du gestionnaire est une référence à l'élément. C'est la même valeur que celle de la propriété currentTarget de l'argument évènement qui est passé au gestionnaire.

mon_element.addEventListener('click', function (e) {
  console.log(this.className)           // journalise le className de mon_element
  console.log(e.currentTarget === this) // journalise `true`
})

Pour mémoire, les fonctions fléchées n'ont pas leur propre contexte this.

mon_element.addEventListener('click', (e) => {
  console.log(this.className)           // ATTENTION : `this` n'est pas `mon_element`
  console.log(e.currentTarget === this) // journalise `false`
})

Si un attribut d'évènement (par exemple, onclick) est spécifié dans un élément dans le source HTML, le code JavaScript dans la valeur de l'attribut est effectivement encapsulé dans une fonction gestionnaire qui lie la valeur de this d'une manière cohérente avec l'addEventListener() ; une occurrence de this dans le code représente une référence à l'élément.

<table id="ma_table" onclick="console.log(this.id);"><!-- `this` fait référence à la table ; journalise 'ma_table' -->
  ...
</table>

Notez que la valeur de this à l'intérieur d'une fonction, appelée par le code dans la valeur de l'attribut, se comporte selon les règles standard. Ceci est illustré dans l'exemple suivant :

<script>
  function journaliserID() { console.log(this.id); }
</script>
<table id="ma_table" onclick="journaliserID();"><!-- lorsqu'appelée, `this` fera référence à l'objet global -->
  ...
</table>

La valeur de this à l'intérieur de journaliserID est une référence à l'objet global Window (ou undefined dans le cas du mode strict).

Spécification de "this" en utilisant bind()

La méthode Function.prototype.bind() vous permet de spécifier la valeur qui doit être utilisée comme this pour tous les appels à une fonction donnée. Cette méthode vous permet de contourner facilement les problèmes dans lesquels ce que this sera n'est pas clair, en fonction du contexte depuis lequel votre fonction a été appelée. Notez toutefois que vous aurez besoin de conserver quelque part une référence à l'écouteur, de façon à pouvoir le supprimer ultérieurement.

Ceci est un exemple avec et sans bind() :

var QuelqueChose = function(element) {
  // |this| est un objet nouvellement créé
  this.name = 'Quelque Chose de Bon';
  this.onclick1 = function(evenement) {
    console.log(this.name); // undefined, du fait que |this| est l'élément
  };
  this.onclick2 = function(evenement) {
    console.log(this.name); // 'Quelque Chose de Bon', du fait que |this| est lié à l'objet nouvellement créé
  };
  element.addEventListener('click', this.onclick1, false);
  element.addEventListener('click', this.onclick2.bind(this), false); // Astuce
}
var q = new QuelqueChose(document.body);

Une autre solution consiste à utiliser une fonction spéciale appelée handleEvent() to intercepter tous les évènements :

const QuelqueChose = function(element) {
  // |this| est un objet nouvellement créé
  this.name = 'Quelque Chose de Bon';
  this.handleEvent = function(evenement) {
    console.log(this.name); // 'Quelque Chose de Bon', du fait que this est lié à l'objet nouvellement créé
    switch(evenement.type) {
      case 'click':
        // un peu de code ici...
        break;
      case 'dblclick':
        // un peu de code ici...
        break;
    }
  };

  // Notez que les écouteurs dans ce cas sont |this|, pas this.handleEvent
  element.addEventListener('click', this, false);
  element.addEventListener('dblclick', this, false);

  // Vous pouvez enlever correctement les écouteurs
  element.removeEventListener('click', this, false);
  element.removeEventListener('dblclick', this, false);
}
const q = new QuelqueChose(document.body);

Une autre manière de gérer la référence à this est de passer à l'EventListener une fonction qui appelle la méthode de l'objet qui contient les champs auxquels on a besoin d'accéder :

class UneClasse {

  constructor() {
    this.name = 'Quelque Chose de Bon';
  }

  enregistrer() {
    const cela = this;
    window.addEventListener('keydown', function(e) { cela.uneMethode(e); });
  }

  uneMethode(e) {
    console.log(this.name);
    switch(e.keyCode) {
      case 5:
        // un peu de code ici...
        break;
      case 6:
        // un peu de code ici...
        break;
    }
  }

}

const monObjet = new UneClass();
monObjet.enregistrer();

Passer des données à et depuis un écouteur d'évènements

On peut avoir l'impression que les écouteurs d'évènements sont comme des îles et qu'il est extrêmement difficile de leur passer des données quelconques, encore moins d'en récupérer après qu'ils ont été exécutés. Les écouteurs d'évènements ne prennent qu'un seul argument, l'Event Object, qui est passé automatiquement à l'écouteur, et la valeur retournée est ignorée. Donc à nouveau, comment pouvons-nous leur passer des données et en récupérer ? Il y a certain nombre de bonnes méthodes pour ce faire.

Passer des données à un écouteur d'évènement en utilisant "this"

Comme mentionné ci-dessus, vous pouvez utiliser Function.prototype.bind() pour passer une valeur à un écouteur d'évènements via la variable de référence this.

const monBouton = document.getElementById('id-de-mon-bouton');
const uneChaine = 'Données';

monButton.addEventListener('click', function () {
  console.log(this);  // Valeur Attendue : 'Données'
}.bind(uneChaine));

Cette méthode est appropriée quand vous n'avez pas besoin de savoir sur quel élément HTML l'écouteur d'évènement a été déclenché par programme depuis l'intérieur de l'écouteur d'évènements. Le principal avantage de cette façon de faire est que l'écouteur d'évènements reçoit les données sensiblement de la même manière qu'il le ferait si vous les lui passiez au moyen de sa liste d'arguments.

Passer des données à un écouteur d'évènements en utilisant une propriété de portée externe

Quand une portée externe contient une déclaration de variable (avec const, let), toutes les fonctions internes déclarées dans cette portée ont accès à cette variable (voir ici pour des informations sur les fonctions externes/internes, et ici pour des informations sur la portée des variables). Par conséquent, une des façons les plus simples pour accéder à des données depuis l'extérieur d'un écouteur d'évènements est de le rendre accessible dans la portée dans laquelle l'écouteur d'évènement est déclaré.

const monButton = document.getElementById('id-de-mon-bouton');
const uneChaine = 'Données';

monButton.addEventListener('click', function() {
  console.log(uneChaine);  // Valeur Attendue : 'Données'

  uneChaine = 'Encore des Données';
});

console.log(uneChaine);  // Valeur Attendue : 'Données' (ne produira jamais 'Encore des Données')

Note : Bien que les portées internes aient accès aux variables const et let depuis les portées externes, vous ne pouvez pas vous attendre à ce que des changements quelconques de ces variables soient accessibles après la définition de l'écouteur d'évènements, à l'intérieur de la même portée externe. Pourquoi ? Simplement parce qu'au moment où l'écouteur d'évènements s'exécutera, la portée dans laquelle il a été défini pourra avoir déjà fini de s'exécuter.

Passer des données à et depuis un écouteur d'évènements en utilisant des objets

A l'inverse de la plupart des fonctions en JavaScript, les objets sont conservés en mémoire aussi longtemps qu'une variable les référençant existe en mémoire. Ceci, et le fait que les objets peuvent avoir des propriétés, et qu'ils peuvent être passés alentour par référence, en fait des candidats plausibles pour partager des données entre les portées. Explorons cela.

Note : les fonctions en JavaScript sont en fait des objets. (Par conséquent, elles aussi peuvent avoir des propriétés, et seront conservées en mémoire même après qu'elles ont fini de s'exécuter, si elles ont été affectées à une variable qui persiste en mémoire.)

Du fait que les propriétés d'un objet peuvent être utilisées pour stocker des données en mémoire aussi longtemps qu'une variable référençant l'objet existe en mémoire, vous pouvez en fait les utiliser pour passer des données dans un écouteur d'évènements, et retourner tous les changements aux données après que l'écouteur d'évènements s'est exécuté. Considérez cet exemple :

const monBouton = document.getElementById('id-de-mon-bouton');
const unObjet = {unePropriete: 'Données'};

monButton.addEventListener('click', function() {
  console.log(unObjet.unePropriete);  // Valeur Attendue : 'Données'

  unObjet.unePropriete = 'Encore des Données';  // Changer la valeur
});

window.setInterval(function() {
  if (unObjet.unePropriete === 'Encore des Données') {
    console.log('Encore des Données: Vrai');
    unObjet.unePropriete = 'Données';  // Réinitialiser la valeur pour attendre la prochaine exécution de l'évènement
  }
}, 5000);

Dans cet exemple, même si la portée dans laquelle à la fois l'écouteur d'évènements et la fonction d'intervalle ont été définis a fini de s'exécuter avant que la valeur originale de unObjet.unePropriete ait changé, du fait que someObject persiste en mémoire (par référence) à la fois dans l'écouteur d'évènements et dans la fonction d'intervalle, tous deux ont accès aux mêmes données (i.e. quand l'un change les données, l'autre peut répondre aux changements).

Note : les objets sont stockés dans les variables par référence, ce qui signifie que seul l'emplacement en mémoire des données elles-mêmes est stocké dans la variable. Entre autres choses, cela signifie que les variables qui "stockent" des objets peuvent en fait affecter d'autres variables qui se voient affecter ("stocker") la même référence d'objet. Quand deux variables référencent le même objet (par ex., let a = b = {unePropriete: 'Ouais'};), le fait de changer les données dans l'une ou l'autre des variables affectera l'autre.

Note : du fait que les objets sont stockés dans les variables par référence, vous pouvez retourner un objet depuis une fonction pour le maintenir en vie (le conserver en mémoire, de sorte que vous n'en perdiez pas les données) après que cette fonction a fini de s'exécuter.

  Héritage Internet Explorer et attachEvent

Dans les versions Internet Explorer versions avant IE 9, vous deviez utiliser attachEvent(), plutôt que la méthode standard addEventListener. Pour IE, nous modifions l'exemple précédent en :

if (el.addEventListener) {
  el.addEventListener('click', modifierTexte, false); 
} else if (el.attachEvent)  {
  el.attachEvent('onclick', modifierTexte);
}

Il y a un inconvénient avec attachEvent : la valeur de this sera une référence à l'objet window, au lieu de l'élément sur lequel il a été déclenché.

La méthode attachEvent() peut être couplée avec l'évènement onresize pour détecter que certains éléments dans une page web ont été redimensionnés. L'évènement propriétaire mselementresize, lorsqu'il est couplé avec la méthode addEventListener d'enregistrement des gestionnaires d'évènements, fournit une fonctionnalité similaire à celle de onresize, se déclenchant quand certains éléments HTML sont redimensionnés.

Émulation

Vous pouvez contourner le fait que addEventListener(), removeEventListener(), Event.preventDefault() et Event.stopPropagation() ne sont pas pris en charge par IE 8 en utilisant le code suivant au début de votre script. Le code prend en charge l'utilisation de handleEvent(), et aussi l'évènement DOMContentLoaded.

Note : useCapture n'est pas pris en charge, du fait qu'IE 8 n'a aucune méthode alternative. Le code suivant ajoute seulement la prise en charge d'IE 8. Cette émulation pour IE 8 fonctionne uniquement en mode standard : une déclaration doctype est requise.

(function() {
  if (!Event.prototype.preventDefault) {
    Event.prototype.preventDefault=function() {
      this.returnValue=false;
    };
  }
  if (!Event.prototype.stopPropagation) {
    Event.prototype.stopPropagation=function() {
      this.cancelBubble=true;
    };
  }
  if (!Element.prototype.addEventListener) {
    var eventListeners=[];
    
    var addEventListener=function(type,listener /*, useCapture (sera ignoré) */) {
      var self=this;
      var wrapper=function(e) {
        e.target=e.srcElement;
        e.currentTarget=self;
        if (typeof listener.handleEvent != 'undefined') {
          listener.handleEvent(e);
        } else {
          listener.call(self,e);
        }
      };
      if (type=="DOMContentLoaded") {
        var wrapper2=function(e) {
          if (document.readyState=="complete") {
            wrapper(e);
          }
        };
        document.attachEvent("onreadystatechange",wrapper2);
        eventListeners.push({object:this,type:type,listener:listener,wrapper:wrapper2});
        
        if (document.readyState=="complete") {
          var e=new Event();
          e.srcElement=window;
          wrapper2(e);
        }
      } else {
        this.attachEvent("on"+type,wrapper);
        eventListeners.push({object:this,type:type,listener:listener,wrapper:wrapper});
      }
    };
    var removeEventListener=function(type,listener /*, useCapture (sera ignoré) */) {
      var counter=0;
      while (counter<eventListeners.length) {
        var eventListener=eventListeners[counter];
        if (eventListener.object==this && eventListener.type==type && eventListener.listener==listener) {
          if (type=="DOMContentLoaded") {
            this.detachEvent("onreadystatechange",eventListener.wrapper);
          } else {
            this.detachEvent("on"+type,eventListener.wrapper);
          }
          eventListeners.splice(counter, 1);
          break;
        }
        ++counter;
      }
    };
    Element.prototype.addEventListener=addEventListener;
    Element.prototype.removeEventListener=removeEventListener;
    if (HTMLDocument) {
      HTMLDocument.prototype.addEventListener=addEventListener;
      HTMLDocument.prototype.removeEventListener=removeEventListener;
    }
    if (Window) {
      Window.prototype.addEventListener=addEventListener;
      Window.prototype.removeEventListener=removeEventListener;
    }
  }
})();

Ancienne manière d'enregistrer les écouteurs d'évènements

La méthode addEventListener() a été ajoutée dans la spécification DOM 2 Events. Avant cela, les écouteurs d'évènements étaient enregistrés de la manière suivante :

// Passage d'une référence à une fonction — ne pas ajouter de '()' après, cela appelerait la fonction !
el.onclick = modifierTexte;
 
// Utilisation d'une fonction directe
element.onclick = function() {
  ...logique de la fonction...
};

Cette méthode remplace l'(les)écouteur(s) d'évènements click existant(s) de l'élément s'il y en a. D'autres évènements et leurs gestionnaires d'évènements associés comme blur (onblur), et  keypress ( onkeypress) se comportent de façon similaire.

Comme elle faisait partie de façon fondamentale du DOM 0, cette méthode est très largement prise en charge et ne nécessite aucun code multi-navigateur. C'est pourquoi elle est souvent utilisée pour enregistrer des évènements dynamiquement quand de très anciens navigateurs (comme IE <=8) doivent être pris en charge ; voir la table plus bas pour les détails de la prise en charge par les navigateurs pour addEventListener.

Problèmes de mémoire

var i;
var els = document.getElementsByTagName('*');

// Cas 1
for(i=0 ; i<els.length ; i++){
  els[i].addEventListener("click", function(e){/*faire quelque chose*/}, false);
}

// Cas 2
function traiterEvenement(e){
  /* faire quelque chose */
}

for(i=0 ; i<els.length ; i++){
  els[i].addEventListener("click", traiterEvenement, false);
}

Dans le premier cas ci-dessus, une nouvelle fonction gestionnaire (anonyme) est créée à chaque itération de la boucle. Dans le second cas, la même fonction déclarée préalablement est utilisée comme gestionnaire d'évènements. Cela entraîne une consommation de mémoire réduite. De plus, dans le premier cas, il n'est pas possible d'appeler removeEventListener() du fait qu'aucune référence à la fonction anonyme n'est conservée (ou ici, n'est conservée aucune des multiples fonctions anonymes que la boucle peut créer). Dans le second cas, il est possible de faire monElement.removeEventListener("click", traiterEvenement, false) du fait que traiterEvenement est la référence à la fonction.

En fait, en ce qui concerne la consommation de mémoire, l'absence de conservation d'une référence à la fonction n'est pas le problème réel ; c'est plutôt l'absence de conservation d'une référence STATIQUE à la fonction. Dans les deux cas à problème ci-dessous, une référence à la fonction est conservée, mais du fait qu'elle est redéfinie à chaque itération, elle n'est pas statique. Dans le troisème cas, la référence à la fonction anonyme est réaffectée à chaque itération. Dans le quatrième cas, la définition entière de la fonction est inchangée, mais elle est néanmoins répétitivement définie comme si elle était nouvelle (à moins qu'elle n'ait été [[promue]] par le compilateur), et elle n'est donc pas statique. Par conséquent, bien qu'il ne semble y avoir simplement que des [[Multiple identical event listeners]], dans les deux cas, chaque itération créera à la place un nouvel écouteur avec sa propre unique référence à la fonction gestionnaire. Cependant, du fait que la définition de la fonction elle-même ne change pas, la MÊME fonction peut toujours être appelée pour chaque écouteur dupliqué (spécialement si le code est optimisé.)

Également dans les deux cas, du fait que la référence à la fonction e été conservée mais est répétitivement redéfinie par chaque ajout, l'instruction 'remove' ci-dessus peut toujours supprimer un écouteur, mais seulement le dernier ajouté.

// Pour illustration seulement : notez la "FAUTE" de [j] au lieu de [i] entrainant ainsi que les évènements voulus sont tous enregistrés pour le MÊME élément

// Cas 3
for(let i=0, j=0 ; i<els.length ; i++){
  /* faire des tas de choses avec j */
  els[j].addEventListener("click", traiterEvenement = function(e){/*faire quelque chose*/}, false);
}

// Cas 4
for(let i=0, j=0 ; i<els.length ; i++){
  /* faire des tas de choses avec  j */
  function traiterEvenement(e){/*faire quelque chose*/};
  els[j].addEventListener("click", traiterEvenement, false); 
}

Amélioration des performances de défilement avec les écouteurs passifs

D'après la spécification, la valeur par défaut pour l'option passive est toujours false (faux). Toutefois, cela introduit la possibilité que des écouteurs d'évènements gérant certains évènements tactiles (parmi d'autres) bloquent le fil d'exécution principal du navigateur pendant qu'il essaye de gérer le défilement, avec pour résultat une possiblement énorme réduction de performance pendant la gestion du défilement.

Pour prévenir ce problème, certains navigateurs (spécifiquement, Chrome et Firefox) ont changé la valeur par défault de l'option passive à true pour les évènements touchstart et touchmove dans les nœuds de niveau document Window, Document, et Document.body. Cela empêche que l'écouteur d'évènement ne soit appelé, de sorte qu'il ne peut pas bloquer le rendu de la page pendant que l'utilisateur fait un défilement.

Note : voir la table de compatibilité ci-dessous si vous avez besoin de savoir quels navigateurs (et/ou quelles versions de ces navigateurs) implémentent ce comportement modifié.

Vous pouvez passer outre ce comportement en initialisant explicitement la valeur de passive à false, comme montré ci-dessous :

/* Détection de fonctionnalité */
let passiveSiSupportee = false;

try {
  window.addEventListener("test", null, 
    Object.defineProperty(
      {}, 
      "passive", 
      {
        get: function() { passiveSiSupportee = { passive: false }; }
      }
    )
  );
} catch(err) {}

window.addEventListener('scroll', function(evenement) {
  /* faire quelque chose */
  // pas possible d'utiliser evenement.preventDefault();
}, passiveSiSupportee );

Dans les navigateurs anciens qui ne prennent pas en charge le paramètre options d'addEventListener(), le fait d'essayer de l'utiliser empêche l'utilisation de l'argument useCapture sans utilisation appropriée de la détection de fonctionnalité.

Vous n'avez pas besoin de vous inquiéter de la valeur de passive pour l'évènement scroll de base. Du fait qu'il ne peut pas être annulé, les écouteurs d'évènements ne peuvant pas bloquer le rendu de la page de toute façon.

Spécifications

Spécification Statut Commentaire
DOM
La définition de 'EventTarget.addEventListener()' dans cette spécification.
Standard évolutif
DOM4
La définition de 'EventTarget.addEventListener()' dans cette spécification.
Obsolete
Document Object Model (DOM) Level 2 Events Specification
La définition de 'EventTarget.addEventListener()' dans cette spécification.
Obsolete Définition initiale.

Compatibilité des navigateurs

Update compatibility data on GitHub
OrdinateurMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariWebview AndroidChrome pour AndroidFirefox pour AndroidOpera pour AndroidSafari sur iOSSamsung Internet
addEventListenerChrome Support complet 1
Notes
Support complet 1
Notes
Notes Before Chrome 49, the type and listener parameters were optional.
Edge Support complet 12Firefox Support complet 1IE Support complet 9
Support complet 9
Aucun support 6 — 11
Notes Autre nom
Notes Older versions of IE supported an equivalent, proprietary EventTarget.attachEvent() method.
Autre nom Cette fonctionnalité utilise le nom non-standard : attachEvent
Opera Support complet 7Safari Support complet 1WebView Android Support complet 1
Notes
Support complet 1
Notes
Notes Before Chrome 49, the type and listener parameters were optional.
Chrome Android Support complet 18
Notes
Support complet 18
Notes
Notes Before Chrome 49, the type and listener parameters were optional.
Firefox Android Support complet 4Opera Android Support complet 10.1Safari iOS Support complet 1Samsung Internet Android Support complet 1.0
Notes
Support complet 1.0
Notes
Notes Before Samsung Internet 5.0, the type and listener parameters were optional.
useCapture parameter made optionalChrome Support complet 1Edge Support complet 12Firefox Support complet 6IE Support complet 9Opera Support complet 11.6Safari Support complet OuiWebView Android Support complet 1Chrome Android Support complet 18Firefox Android Support complet 6Opera Android Support complet 12Safari iOS Support complet OuiSamsung Internet Android Support complet 1.0
Form with options object supported (third parameter can be either options or a Boolean, for backwards compatibility)Chrome Support complet 49Edge Support complet ≤18Firefox Support complet 49IE Aucun support NonOpera Support complet OuiSafari Support complet 10WebView Android Support complet 49Chrome Android Support complet 49Firefox Android Support complet 49Opera Android Support complet OuiSafari iOS Support complet 10Samsung Internet Android Support complet 5.0
options: capture optionChrome Support complet 52Edge Support complet ≤18Firefox Support complet OuiIE Aucun support NonOpera Support complet OuiSafari Support complet OuiWebView Android Support complet 52Chrome Android Support complet 52Firefox Android Support complet OuiOpera Android Support complet OuiSafari iOS Support complet OuiSamsung Internet Android Support complet 6.0
options: once optionChrome Support complet 55Edge Support complet ≤18Firefox Support complet 50IE Aucun support NonOpera Support complet 42Safari Support complet OuiWebView Android Support complet 55Chrome Android Support complet 55Firefox Android Support complet 50Opera Android Support complet 42Safari iOS Support complet OuiSamsung Internet Android Support complet 6.0
options: passive optionChrome Support complet 51Edge Support complet ≤18Firefox Support complet OuiIE Aucun support NonOpera Support complet OuiSafari Support complet OuiWebView Android Support complet 51Chrome Android Support complet 51Firefox Android Support complet OuiOpera Android Support complet OuiSafari iOS Support complet OuiSamsung Internet Android Support complet 5.0
options: passive option defaults to true for touchstart and touchmove eventsChrome Support complet 55Edge Support complet 79Firefox Support complet 61IE Aucun support NonOpera ? Safari Aucun support NonWebView Android Support complet 55Chrome Android Support complet 55Firefox Android Support complet 61Opera Android ? Safari iOS Aucun support NonSamsung Internet Android Support complet 6.0
options: passive option defaults to true for wheel and mousewheel eventsChrome Support complet 73Edge Support complet 79Firefox ? IE Aucun support NonOpera ? Safari Aucun support NonWebView Android Support complet 73Chrome Android Support complet 73Firefox Android ? Opera Android ? Safari iOS Aucun support NonSamsung Internet Android Support complet 11.0

Légende

Support complet  
Support complet
Aucun support  
Aucun support
Compatibilité inconnue  
Compatibilité inconnue
Voir les notes d'implémentation.
Voir les notes d'implémentation.
Cette fonctionnalité utilise un nom non-standard.
Cette fonctionnalité utilise un nom non-standard.

Voir aussi