--- title: MutationObserver slug: Web/API/MutationObserver translation_of: Web/API/MutationObserver ---

{{APIRef("DOM")}}

MutationObserver fournit un moyen d’intercepter les changements dans le DOM. Il a été conçu pour remplacer les Mutation Events définis dans la spécification DOM3 Events.

Constructeur

MutationObserver()

Le constructeur permettant d’instancier un nouvel observateur de mutations DOM.

new MutationObserver( function callback );
Paramètres
callback
Une fonction qui sera appelée à chaque mutation du DOM. L’observateur appellera cette fonction avec deux arguments. Le premier est un tableau d’objets de type {{domxref("MutationRecord")}} ; le second est l’instance de MutationObserver.

Méthodes d’instance

void observe( {{domxref("Node")}} target, MutationObserverInit options );
void disconnect();
Array takeRecords();

Note: La cible {{domxref("Node")}} ne doit pas être confondue avec celle de NodeJS.

observe()

Inscrit l’instance du MutationObserver afin d’être notifié des mutations DOM du nœud sélectionné.

void observe( {{domxref("Node")}} target, MutationObserverInit options );
Paramètres
target
Le {{domxref("Node")}} (nœud) sur lequel doivent être observées les mutations DOM.
options
Un objet du type MutationObserverInit. Il spécifie quelles mutations DOM sont à rapporter.
Note : ajouter un observateur sur un élément revient à utiliser addEventListener. Si vous observez un élément plusieurs fois, cela n’a pas d’impact, dans le sens où, si vous observez un élément deux fois, la callback ne sera pas appelée deux fois, et vous n’aurez pas besoin d’appeler disconnect() deux fois. En d’autres termes, une fois qu’un élément est observé, l’observer à nouveau avec la même instance n’a pas d’effet. Cependant, si la callback est différente, un nouvel observateur sera ajouté.

disconnect()

L’instance MutationObserver cesse de recevoir les notifications de mutations DOM. Jusqu’à ce que la méthode observe() soit appelée à nouveau, les callbacks de l’observateur ne seront pas invoquées.

void disconnect();

Note : Selon la spécification, un MutationObserver est supprimé par le garbage collector si l'élément cible est supprimé.

takeRecords()

Vide la file des mutations enregistrées du MutationObserver et retourne son contenu.

Array takeRecords();
Valeur de retour
Retourne un tableau de {{domxref("MutationRecord")}}.

MutationObserverInit

MutationObserverInit est un objet pouvant avoir les propriétés suivantes :

Note : Au moins une propriété parmi childList, attributes ou characterData doit être initialisée à true, sinon l’erreur "An invalid or illegal string was specified" sera émise.
Propriété Description
childList true si l’ajout ou la suppression des éléments enfants du nœud visé (incluant les nœuds de texte) sont à observer.
attributes true si les mutations d’attributs du nœud visé sont à observer.
characterData true si les mutation de texte du nœud visé sont à observer.
subtree true si les descendants du nœud visé sont également à observer.
attributeOldValue true si attributes est true et si la valeur des attributs avant mutation doit être enregistrée.
characterDataOldValue true si characterData est true et si la valeur des données avant mutation doit être enregistrée.
attributeFilter Spécifiez un tableau de noms d’attributs locaux (sans namespace) si vous souhaitez n’observer les mutations que sur une partie des attributs.

Exemple d’utilisation

L’exemple suivant est extrait de ce blog.

// Selectionne le noeud dont les mutations seront observées
var targetNode = document.getElementById('some-id');

// Options de l'observateur (quelles sont les mutations à observer)
var config = { attributes: true, childList: true };

// Fonction callback à éxécuter quand une mutation est observée
var callback = function(mutationsList) {
    for(var mutation of mutationsList) {
        if (mutation.type == 'childList') {
            console.log('Un noeud enfant a été ajouté ou supprimé.');
        }
        else if (mutation.type == 'attributes') {
            console.log("L'attribut '" + mutation.attributeName + "' a été modifié.");
        }
    }
};

// Créé une instance de l'observateur lié à la fonction de callback
var observer = new MutationObserver(callback);

// Commence à observer le noeud cible pour les mutations précédemment configurées
observer.observe(targetNode, config);

// L'observation peut être arrêtée par la suite
observer.disconnect();

Autres articles pour en savoir plus (en anglais)

Spécifications

Spécification Statut Commentaire
{{SpecName('DOM WHATWG', '#mutationobserver', 'MutationObserver')}} {{ Spec2('DOM WHATWG') }}  

Compatibilité des navigateurs

{{ CompatibilityTable() }}

Fonctionnalité Chrome Firefox (Gecko) Internet Explorer Opera Safari
Basic support 18 {{ property_prefix("WebKit") }}
26		 {{ CompatGeckoDesktop(14) }} 11 15 6.0 {{ property_prefix("WebKit") }}
Fonctionnalité Android Chrome pour Android Firefox Mobile (Gecko) IE Mobile Opera Mobile Safari Mobile
Basic support {{ CompatUnknown() }} 18 {{ property_prefix("WebKit") }}
26		 {{ CompatGeckoMobile(14) }} {{ CompatUnknown() }} 15

6 {{ property_prefix("WebKit")}}

7