1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
---
title: MutationObserver
slug: Web/API/MutationObserver
translation_of: Web/API/MutationObserver
---
<p>{{APIRef("DOM")}}</p>
<p><code>MutationObserver</code> fournit un moyen d’intercepter les changements dans le <a href="/en-US/docs/DOM">DOM</a>. Il a été conçu pour remplacer les <a href="/en-US/docs/DOM/Mutation_events">Mutation Events</a> définis dans la spécification DOM3 Events.</p>
<h2 id="Constructor">Constructeur</h2>
<h3 id="MutationObserver()"><code>MutationObserver()</code></h3>
<p>Le constructeur permettant d’instancier un nouvel observateur de mutations DOM.</p>
<pre class="syntaxbox">new MutationObserver( function callback );</pre>
<h4 id="Parameters">Paramètres</h4>
<dl>
<dt><code>callback</code></dt>
<dd>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 <code>MutationObserver</code>.</dd>
</dl>
<h2 id="Instance_methods">Méthodes d’instance</h2>
<table class="standard-table">
<tbody>
<tr>
<td><code>void <a href="#observe()">observe</a>( {{domxref("Node")}} target, <a href="#MutationObserverInit">MutationObserverInit</a> options );</code></td>
</tr>
<tr>
<td><code>void <a href="#disconnect()">disconnect</a>();</code></td>
</tr>
<tr>
<td><code>Array <a href="#takeRecords()">takeRecords</a>();</code></td>
</tr>
</tbody>
</table>
<div class="note">
<p><strong>Note :</strong> La cible {{domxref("Node")}} ne doit pas être confondue avec celle de <a href="https://nodejs.org/en/">NodeJS</a>.</p>
</div>
<h3 id="observe()"><code>observe()</code></h3>
<p>Inscrit l’instance du <code>MutationObserver</code> afin d’être notifié des mutations DOM du nœud sélectionné.</p>
<pre class="syntaxbox">void observe( {{domxref("Node")}} target, <a href="#MutationObserverInit"><code>MutationObserverInit</code></a> options );
</pre>
<h4 id="Parameters">Paramètres</h4>
<dl>
<dt><code>target</code></dt>
<dd>Le {{domxref("Node")}} (nœud) sur lequel doivent être observées les mutations DOM.</dd>
<dt><code>options</code></dt>
<dd>Un objet du type <a href="#MutationObserverInit"><code>MutationObserverInit</code></a>. Il spécifie quelles mutations DOM sont à rapporter.</dd>
</dl>
<div class="note">
<p><strong>Note :</strong> ajouter un observateur sur un élément revient à utiliser <code>addEventListener</code>. 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 <code>disconnect()</code> 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é.</p>
</div>
<h3 id="disconnect()"><code>disconnect()</code></h3>
<p>L’instance <code>MutationObserver</code> cesse de recevoir les notifications de mutations DOM. Jusqu’à ce que la méthode <a href="#observe()"><code>observe()</code></a> soit appelée à nouveau, les callbacks de l’observateur ne seront pas invoquées.</p>
<pre class="syntaxbox">void disconnect();
</pre>
<div class="note">
<p><strong>Note :</strong> Selon la <a href="https://dom.spec.whatwg.org/#garbage-collection">spécification</a>, un <code>MutationObserver</code> est supprimé par le garbage collector si l'élément cible est supprimé.</p>
</div>
<h3 id="takeRecords()"><code>takeRecords()</code></h3>
<p>Vide la file des mutations enregistrées du <code>MutationObserver</code> et retourne son contenu.</p>
<pre class="syntaxbox">Array takeRecords();
</pre>
<dl>
<dt>Valeur de retour</dt>
<dd>Retourne un tableau de {{domxref("MutationRecord")}}.</dd>
</dl>
<h2 id="MutationObserverInit"><code>MutationObserverInit</code></h2>
<p><code>MutationObserverInit</code> est un objet pouvant avoir les propriétés suivantes :</p>
<div class="note">
<p><strong>Note :</strong> Au moins une propriété parmi <code>childList</code>, <code>attributes</code> ou <code>characterData</code> doit être initialisée à <code>true</code>, sinon l’erreur <i lang="en">"An invalid or illegal string was specified</i>" sera émise.</p>
</div>
<table class="standard-table">
<tbody>
<tr>
<td class="header">Propriété</td>
<td class="header">Description</td>
</tr>
<tr>
<td><code>childList</code></td>
<td><code>true</code> si l’ajout ou la suppression des éléments enfants du nœud visé (incluant les nœuds de texte) sont à observer.</td>
</tr>
<tr>
<td><code>attributes</code></td>
<td><code>true</code> si les mutations d’attributs du nœud visé sont à observer.</td>
</tr>
<tr>
<td><code>characterData</code></td>
<td><code>true</code> si les mutation de texte du nœud visé sont à observer.</td>
</tr>
<tr>
<td><code>subtree</code></td>
<td><code>true</code> si les descendants du nœud visé sont également à observer.</td>
</tr>
<tr>
<td><code>attributeOldValue</code></td>
<td><code>true</code> si <code>attributes</code> est <code>true</code> et si la valeur des attributs avant mutation doit être enregistrée.</td>
</tr>
<tr>
<td><code>characterDataOldValue</code></td>
<td><code>true</code> si <code>characterData</code> est <code>true</code> et si la valeur des données avant mutation doit être enregistrée.</td>
</tr>
<tr>
<td><code>attributeFilter</code></td>
<td>Spécifiez un tableau de noms d’attributs locaux (sans namespace) si vous souhaitez n’observer les mutations que sur une partie des attributs.</td>
</tr>
</tbody>
</table>
<h2 id="Exemple_d’utilisation">Exemple d’utilisation</h2>
<p>L’exemple suivant est extrait de ce <a href="http://hacks.mozilla.org/2012/05/dom-mutationobserver-reacting-to-dom-changes-without-killing-browser-performance/" rel="freelink">blog</a>.</p>
<pre class="brush: js">// 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();</pre>
<h2 id="Additional_reading">Autres articles pour en savoir plus (en anglais)</h2>
<ul>
<li><a href="http://updates.html5rocks.com/2012/02/Detect-DOM-changes-with-Mutation-Observers" rel="freelink">A brief overview</a></li>
<li><a href="http://hacks.mozilla.org/2012/05/dom-mutationobserver-reacting-to-dom-changes-without-killing-browser-performance/" rel="freelink">A more in-depth discussion</a></li>
<li><a href="http://www.youtube.com/watch?v=eRZ4pO0gVWw" rel="freelink">A screencast by Chromium developer Rafael Weinstein</a></li>
<li><a href="http://code.google.com/p/mutation-summary/" rel="freelink">The mutation summary library</a></li>
<li><a href="http://dom.spec.whatwg.org/#mutation-observers">The DOM standard</a> which defines the <code>MutationObserver</code> interface</li>
</ul>
<h2 id="Spécifications">Spécifications</h2>
<table class="standard-table">
<thead>
<tr>
<th scope="col">Spécification</th>
<th scope="col">Statut</th>
<th scope="col">Commentaire</th>
</tr>
</thead>
<tbody>
<tr>
<td>{{SpecName('DOM WHATWG', '#mutationobserver', 'MutationObserver')}}</td>
<td>{{ Spec2('DOM WHATWG') }}</td>
<td> </td>
</tr>
</tbody>
</table>
<h2 id="Compatibilité_des_navigateurs">Compatibilité des navigateurs</h2>
<p>{{Compat("api.MutationObserver")}}</p>
|
