MutationObserver.MutationObserver()

MutationObserver() コンストラクタ (MutationObserver インターフェースの一部) は、指定されたコールバックをDOMイベントが発生したときに実行するオブザーバを作成して返します。DOMの監視はすぐに開始されるわけではありません。最初に observe() メソッドを呼び出し、DOMのどの部分を監視し、どのような変更を監視するかを決めなければなりません。

構文

var observer = new MutationObserver(callback);

引数

callback
対象となるノードやサブツリー、および指定されたオプションの条件を満たすDOMの変更が起きるたびに呼び出される関数。このコールバック関数は、2つの引数を受け取ります。発生したそれぞれの変更を記述した MutationRecord オブジェクトの配列、そしてコールバックを実行した MutationObserver です。詳細については、以下のを参照してください。

戻り値

指定されたコールバックをDOMの変更が発生したときに呼び出すように設定された MutationObserver オブジェクト。

この例では、ノードとそのすべての子において、ツリーへの要素の追加と削除、およびツリー内の要素の属性の変更を監視するように設定された MutationObserver を作成します。

コールバック関数

function callback(mutationList, observer) {
  mutationList.forEach((mutation) => {
    switch(mutation.type) {
      case 'childList':
        /* ツリーに1つ以上の子が追加されたか、ツリーから削除された。
           mutation.addedNodes と mutation.removedNodes を参照。 */
        break;
      case 'attributes':
        /* Mutation.target の要素の属性値が変更された。
           属性名は mutation.attributeName にあり、
           以前の値は mutation.oldValue にある。 */
        break;
    }
  });
}

callback() 関数は、observe() を呼び出してDOMの監視を開始するときに指定された監視リクエストの設定と一致する変更をオブザーバが確認したときに実行されます。

発生した変更の種類 (子のリストの変更または属性の変更のいずれか) は、mutation.type プロパティを調べることによって判明します。

オブザーバの作成と開始

このコードでは、実際に監視プロセスを設定します。

var targetNode = document.querySelector("#someElement");
var observerOptions = {
  childList: true,
  attributes: true,
  subtree: true // 省略するか、false に設定すると、親ノードへの変更のみを監視する。
}

var observer = new MutationObserver(callback);
observer.observe(targetNode, observerOptions);

目的のサブツリーは、IDが "someElement" の要素を検索することで見つかります。オブザーバのオプションのセットは、observerOptions のレコードで設定します。この中で、childListattributes の両方に true の値を指定することで、目的の情報を得ることができます。

そして、callback() 関数を指定して observer をインスタンス化し、対象のノードとオプションのレコードを指定して observe() を呼び出すことで、対象のDOMノードの監視を開始します。

この時点から disconnect() が呼び出されるまで、targetNode をルートとするDOMツリーに要素が追加されたり削除されたり、あるいは要素の属性が変更されるたびに callback() が呼び出されます。

仕様書

Specification Status Comment
DOM
MutationObserver() の定義
現行の標準

各ブラウザの対応状況

BCD tables only load in the browser