HOWTO · JavaScript

JavaScript で DOM に要素が存在するかどうかをチェックする

このチュートリアルでは、JavaScript で DOM に要素が存在するかどうかを確認する方法を説明します。

このページの内容

一致する要素があるか調べるには、識別方法に合った検索を使います。document.getElementById() は一致した要素、または null を返すため、結果が truthy かどうかを確認します。一方、クラスやタグによる検索はコレクションを返します。空のコレクションも truthy なので、length を調べてください。

getElementById() で一致する要素を1つ取得する

要素の一意な id が分かっている場合は、getElementById() を使います。IDが一致すれば Element を1つ返し、一致する要素がなければ null を返します。IDを渡すときに # は付けません。

次のブラウザー上の例では、IDが help-link のリンクを検索します。コード内のリンクラベルと表示結果は英語のままです。

<a id="help-link" href="/help">Help</a>
<script>
  const helpLink = document.getElementById("help-link");
  const exists = helpLink !== null;
  console.log(exists);
</script>

exists 変数の型は Boolean です。Boolean(helpLink) または !!helpLink を使っても、結果を true または false に変換できます。検索結果の戻り値を明示して判定したい場合は、!== null を使います。

クラス、name、タグで一致する要素を検索する

クラスによる検索には getElementsByClassName()、name 属性による検索には getElementsByName()、要素タグによる検索には getElementsByTagName() を使います。それぞれ異なる属性を対象にします。たとえば、クラスの値は class 属性に、フォームコントロールの名前は name 属性に指定します。

このセクションのコードと表示されるラベルや出力は英語のままです。

<input class="search-field" name="query">
<script>
  const byClass = document.getElementsByClassName("search-field");
  const byName = document.getElementsByName("query");
  const byTag = document.getElementsByTagName("input");

  console.log(byClass.length > 0);
  console.log(byName.length > 0);
  console.log(byTag.length > 0);
</script>

getElementsByClassName() と getElementsByTagName() はライブな HTMLCollection オブジェクトを返します。getElementsByName() は NodeList を返します。一致する要素がない場合、コレクションの長さは 0 ですが、null ではなくオブジェクトです。一致する要素があるかは、collection.length > 0(または collection.length !== 0)で確認します。

検索結果と Boolean による判定を理解する

要素を1つ返す検索とコレクションを返す検索では、存在確認の方法が異なります。getElementById() の結果は Boolean(element) で変換するか、null と比較します。クラス、name、タグによる検索で得たコレクションでは、代わりに length を確認してください。コレクションに直接 !! を適用しても、要素が含まれているかどうかは分かりません。空のコレクションも、要素を含むコレクションも truthy です。

「このIDに一致する要素が1つあるか」と「この条件に一致する要素はいくつあるか」のどちらを知りたいかに応じて、APIを選びます。取得した要素を後で使う場合は、早い段階で Boolean に変換せず、要素またはコレクションを保持してください。

次の例を実行してください。

このセクションのコードと表示されるラベルや出力は英語のままです。

const matches = [{ id: "help-link" }];
const exists = matches.length > 0;
console.log(exists);

この例は、コレクションの長さを確認する独立した例です。上のDOM固有のコード断片はブラウザー上で実行するためのもので、ここでは実行していません。

ノードが document.body 内にあるか確認する

document.body.contains(node) は、node が body 自身またはその子孫であるかを示す Boolean を返します。調べるのはDOMツリー上の包含関係であり、ノードが画面に表示されているかどうかではありません。ノードが body 内にあっても、CSSで非表示になっているなど、画面に表示されない場合があります。

contains() にはノードを1つ渡します。検索結果がコレクションなら、先に項目を選び、コレクションが空の場合も考慮してください。たとえば、const matches = document.getElementsByName("query"); const isInBody = matches.length > 0 && document.body.contains(matches[0]); は最初に一致したノードだけを調べ、すべての一致項目を確認するものではありません。一致したノードのうち、どれかがbody内にあるかを調べたい場合は、各項目を個別に確認します。