ジャンルから探す

Web Design English

JavaScriptでclassの変更を検知する方法|MutationObserverの使い方

JavaScriptで要素のclassが変更されたことを検知して、処理を走らせる方法を解説します。

結論から書くと、MutationObserver を使ってください。他の方法もありますが、実務で選ぶ理由があるのはこれだけです。

この記事は複数の手法を比較する形で書いていますが、そのうち DOMAttrModified はすでにブラウザから削除されており、現在は動きません。2024年7月のChrome 127で削除されています。以下、それぞれの現在の扱いも含めて解説します。

▼手法ごとの現在の扱い

方法 現在の扱い
MutationObserver これを使う
setInterval でのポーリング 動くが無駄が多い
Proxy 直接の変更を検知できない
Object.defineProperty 標準の挙動を壊す危険がある
DOMAttrModified 削除済み。動きません
animationend 用途が違う(アニメーション終了の検知)

スポンサーリンク

class要素の変更を監視する方法

「MutationObserver」を使用する

結論:MutationObserver がDOMの変更を監視する標準の方法です。class の変更を検知したいなら、これ一択と考えて構いません。

変更をまとめて(バッチで)通知する設計なので、1回の操作で属性が何度書き換わっても処理は1回で済みます。ブラウザの最適化を妨げないため、性能面でも他の方法より有利です。

const targetElement = document.querySelector('.target-element');

const observer = new MutationObserver((mutations) => {
  mutations.forEach((mutation) => {
    if (mutation.attributeName === 'class') {
      // class要素が変更されたときの処理を記述
    }
  });
});

// class の変更だけを監視する
const config = {
  attributes: true,
  attributeFilter: ['class'],   // 監視する属性を絞る
  attributeOldValue: true       // 変更前の値も受け取る
};

observer.observe(targetElement, config);

attributeFilter で監視対象を絞ってください。{ attributes: true } だけだと style や data-* を含むすべての属性変更でコールバックが呼ばれます。class だけが必要なら、そう書いたほうが無駄が減ります。

attributeOldValue: true を付けると、コールバックの mutation.oldValue から変更前の値が取れます。「特定のクラスが付いた瞬間」を検知したいときに使えます。

const observer = new MutationObserver((mutations) => {
  for (const mutation of mutations) {
    const before = mutation.oldValue || '';
    const after = mutation.target.className;
    if (!before.includes('is-active') && after.includes('is-active')) {
      // is-active が付いた瞬間の処理
    }
  }
});

監視をやめるときは disconnect() を呼びます。これを忘れると、要素を削除したあとも監視が残り続けます。

observer.disconnect();

「setInterval」を使ったポーリング

setIntervalを使用して、一定の間隔でclass属性の変更を監視する方法です。シンプルですが、変更が無くても処理が走り続けます。下の例では100ミリ秒ごと、つまり1分間に600回チェックすることになります。

MutationObserver が使えない事情が無い限り、これを選ぶ理由はありません。検知も最大100ミリ秒遅れます。

const targetElement = document.querySelector('.target-element');
let previousClass = targetElement.className;

setInterval(() => {
  if (targetElement.className !== previousClass) {
    previousClass = targetElement.className;
    // class要素が変更されたときの処理を記述
  }
}, 100);

「Proxy」を使ったオブジェクト監視

Proxyを利用して、class属性の変更を監視する方法です。

ただしこの方法には大きな制約があります。検知できるのは Proxy 経由(下の例の proxyElement)で変更したときだけで、元の要素を直接触った変更や、他のライブラリによる変更は捕捉できません。実務で class の監視に使う場面はほとんどありません。

const targetElement = document.querySelector('.target-element');

const handler = {
  set(target, property, value) {
    if (property === 'className') {
      // class要素が変更されたときの処理を記述
    }
    target[property] = value;
    return true;
  }
};

const proxyElement = new Proxy(targetElement, handler);
proxyElement.className = 'new-class'; // この変更が検知される

「Object.defineProperty」を使ったプロパティ監視

Object.definePropertyを利用してclassNameプロパティの変更を監視する方法です。

この方法は標準の挙動を壊すため、おすすめしません。className を自前のgetter/setterで上書きすると、classList.add() など他の経路からの変更が反映されなくなることがあります。動くように見えても、後から原因の分かりにくい不具合になります。

const targetElement = document.querySelector('.target-element');
let classNameValue = targetElement.className;

Object.defineProperty(targetElement, 'className', {
  get() {
    return classNameValue;
  },
  set(newValue) {
    classNameValue = newValue;
    // class要素が変更されたときの処理を記述
  }
});

クラス変更イベントのハンドリング

「addEventListener」を使用する

この方法はもう使えません。DOMAttrModified を含む Mutation Events は2011年から非推奨で、2024年7月のChrome 127で削除されました。Firefox でも非推奨の警告が出ます。

参考として当時のコードを残しますが、現在このコードを書いてもイベントは発火しません。同じことをするなら、この記事の最初に挙げた MutationObserver に置き換えてください。

const targetElement = document.querySelector('.target-element');

targetElement.addEventListener('DOMAttrModified', (event) => {
  if (event.attrName === 'class') {
    // class要素が変更されたときの処理を記述
  }
});

CSSアニメーションの終了イベントを利用

これはclassの変更そのものを検知する方法ではありません。classが変わった結果として始まったCSSアニメーションの、終了タイミングを拾う方法です。

「クラスを付けてアニメーションさせ、終わったら要素を消す」といった処理に使います。トランジションの場合は transitionend を使ってください。

const targetElement = document.querySelector('.target-element');

targetElement.addEventListener('animationend', () => {
  // アニメーション終了時の処理を記述
});

まとめ

結論:class の変更を検知したいなら MutationObserver を使ってください。他の方法は、動かない(DOMAttrModified)、無駄が多い(setInterval)、取りこぼす(Proxy)、壊す(Object.defineProperty)のいずれかです。

MutationObserver を使うときの要点は3つです。

  • attributeFilter: ['class'] で監視対象を絞る
  • 変更前の値が要るなら attributeOldValue: true
  • 不要になったら disconnect() を呼ぶ

そもそもクラスの変更を監視せずに済むなら、そのほうが確実です。自分のコードでクラスを付け替えているなら、その処理の中で直接呼べば監視は要りません。監視が必要になるのは、外部のライブラリや自分の管理外のコードがクラスを書き換える場合に限られます。

要素を辿る処理でつまずいたら、jQueryで親要素を取得する方法に素のJavaScriptでの書き方もまとめています。クラスの付け外しで見た目を変える実装例は、CSSとjQueryでアコーディオンを実装するをどうぞ。