Cette page a été traduite à partir de l'anglais par la communauté.Vous pouvez contribuer en rejoignant la communauté francophone sur MDN Web Docs.
MutationObserver
Baseline Widely available
Cette fonctionnalité est bien établie et fonctionne sur de nombreux appareils et versions de navigateurs. Elle est disponible sur tous les navigateurs depuis juillet 2015.
MutationObserver fournit un moyen d'intercepter les changements dans leDOM. Il a été conçu pour remplacer lesMutation 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
callbackUne 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
MutationRecord; le second est l'instance deMutationObserver.
Méthodes d'instance
voidobserve( |
voiddisconnect(); |
ArraytakeRecords(); |
observe()
Inscrit l'instance duMutationObserver afin d'être notifié des mutations DOM du nœud sélectionné.
void observe(Node target, MutationObserverInit options );Paramètres
targetLe
Node(nœud) sur lequel doivent être observées les mutations DOM.optionsUn objet du type
MutationObserverInit. Il spécifie quelles mutations DOM sont à rapporter.
Note :Ajouter un observateur sur un élément revient à utiliseraddEventListener. 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'appelerdisconnect() 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'instanceMutationObserver cesse de recevoir les notifications de mutations DOM. Jusqu'à ce que la méthodeobserve() soit appelée à nouveau, les callbacks de l'observateur ne seront pas invoquées.
void disconnect();
Note :Selon laspécification, unMutationObserver est supprimé par le garbage collector si l'élément cible est supprimé.
takeRecords()
Vide la file des mutations enregistrées duMutationObserver et retourne son contenu.
Array takeRecords();
- Valeur de retour
Retourne un tableau de
MutationRecord.
MutationObserverInit
MutationObserverInit est un objet pouvant avoir les propriétés suivantes :
Note :Au moins une propriété parmichildList,attributes oucharacterData 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 mutations de texte du nœud visé sont à observer. |
subtree | true si les descendants du nœud visé sont également à observer. |
attributeOldValue | true siattributes esttrue et si la valeur des attributs avant mutation doit être enregistrée. |
characterDataOldValue | true sicharacterData esttrue 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 ceblog.
// Selectionne le noeud dont les mutations seront observéesvar 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éevar 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 callbackvar observer = new MutationObserver(callback);// Commence à observer le noeud cible pour les mutations précédemment configuréesobserver.observe(targetNode, config);// L'observation peut être arrêtée par la suiteobserver.disconnect();Autres articles pour en savoir plus (en anglais)
- A brief overview
- A more in-depth discussion
- A screencast by Chromium developer Rafael Weinstein
- The mutation summary library
- The DOM standard which defines the
MutationObserverinterface
Spécifications
| Specification |
|---|
| DOM # interface-mutationobserver |