Element.getElementsByClassName()

names

一致させる一つ以上のクラス名を表す DOMString で、クラス名は空白区切りで指定できます。

HTMLCollection で、 names で指定したすべてのクラスを持つすべての要素のライブで更新されるリストです。

この関数が返すコレクションは常に生きています。つまり、この関数を呼び出された要素をルートとする DOM ツリーの現在の状態が常に反映されています。サブツリー上で names に一致する新しい要素が追加された場合は、直ちにこのコレクションに追加されます。同様に、サブツリー上にある names に一致しなかった要素が一致するよう変更された場合も、すぐにこのコレクションに現れます。

逆もしかりです。 names に一致しなくなったりツリーから外された要素は、すぐにコレクションから除外されます。

単一の指定されたクラスを含む要素を探すには、 getElementsByClassName() を呼び出す際にそのクラス名を指定するだけです。

element.getElementsByClassName('test');

この例は main の id を持つ要素の子孫の中で、test クラスをもつ全要素を見つけます。

document.getElementById('main').getElementsByClassName('test');

red と test 両方のクラスを含んだ要素を見つけます。

element.getElementsByClassName('red test');

標準の配列構文や、HTMLCollection の item() (en-US) メソッドを使うことで、返されたコレクションの要素を調査することができます。しかし、次の例はうまく動作しないでしょう。colorbox クラスを外した際に、matches がすぐに変更されてしまうからです。

var matches = element.getElementsByClassName('colorbox');

for (var i=0; i<matches.length; i++) {
  matches[i].classList.remove('colorbox');
  matches.item(i).classList.add('hueframe');
}

別の手段を使いましょう。例えば、

var matches = element.getElementsByClassName('colorbox');

while (matches.length > 0) {
  matches.item(0).classList.add('hueframe');
  matches[0].classList.remove('colorbox');
}

このコードは、"colorbox" クラスを持つ子孫要素を見つけ、item(0)を呼び出して "hueframe" クラスを追加し、（配列記法で） "colorbox" を削除します。その後、（もし残っていれば）別の要素が item(0) になります。

このメソッドの戻り値を this 値として Array.prototype メソッドに与えることで、任意の HTMLCollection で Array メソッドを使うことができます。次の例では test クラスを持つすべての <div> 要素を見つけられます。

var testElements = document.getElementsByClassName('test');
var testDivs = Array.prototype.filter.call(testElements, function(testElement) {
  return testElement.nodeName === 'DIV';
});