明るく

暗く

JavaScript

addEventListenerを使用する時の注意点とエラーの解決方法

addEventListenerを使用する時の注意点とエラーの解決方法

addEventListenerを書いたのにクリックや入力をしても何も起きないときは、まず検証画面のコンソールを開いて、何が表示されているかを確認しましょう。表示によって、原因と直し方が次のように分かれます。

 

コンソールの表示 原因
〜.addEventListener is not a function getElementsByClassName などで、複数の要素をまとめて取得している
Cannot read properties of null 取得しようとした要素が見つかっていない
何も表示されない 操作した要素にリスナーを登録できていない、または同じイベントに処理を2つ登録している

 

税込計算after

is not a function が出るときは、要素をまとめて取得している

コンソールに「〜.addEventListener is not a function」と出るときは、getElementsByClassName などで複数の要素をまとめて取得し、その集まりに addEventListener を付けようとしています。この場合、要素を1つだけ取得するように書き換えると直ります。

getElementsByClassName で取得すると is not a function が出る

どのようなときにaddEventListenerでgetElementsByClassNameが使えなくなるのか、「税込金額計算ツール」の実装過程から見ていきます。

 

※OS環境はMacOS、エディタはVisual Studio Codeを使用

  1. HTML・CSSで、入力ボックス・計算結果の外観を作成します。今回は、”item_price”クラス内に金額を入力し、”total_price”クラスで計算値を出力します。

 

<!DOCTYPE html>
<html lang="ja">
<head>
 <meta charset="UTF-8">
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 <title>税込価格を表示する</title>
 <style>
   input{
     width: 200px;
     font-size: 16px;
     padding: 8px;
     margin-bottom: 8px;
    }
 </style>
</head>
<body>
 <input type="number" class="item_price" placeholder="金額を入力してください">
 <div class="total_price"></div>
</body>
</html>

 

  1. 税込金額を自動計算・表示させるために、以下のJavaScriptを入力します。

 

<script>
  // "item_price" クラスの要素(入力した値)を、変数:inputPrice と定義//
 const inputPrice = document.getElementsByClassName("item_price");
 // "total_price" クラスの要素(税込で表示する値)を、変数:totalPrice と定義//
 const totalPrice = document.getElementsByClassName("total_price");
 // "item_price" クラスに値が入力されたときの処理を、addEventListenerで指定//
 inputPrice.addEventListener('input', function() {
  //入力された値が空白の場合は、空白で返す(NaNと表示されるのを防止)//
  if (inputPrice.value === '') {
      totalPrice.textContent = '';
      return;
  }
  //税率を設定する(今回は10%)//
  const taxRate = 0.1;
  //変数:totalPriceに、「税込価格:”入力値の税込金額”円」(小数点第2位まで)を代入する=>"total_price"クラスに税込金額を表示//
  totalPrice.textContent = `税込価格: ${(inputPrice.value * (1 + taxRate)).toFixed(2)} 円`;
 });
</script>

 

  1. ボックスに数値を入力しても、なぜか税込金額は表示されません。

 

税込計算before

 

  1. 検証画面でエラー内容を確認したところ、Uncaught TypeError: inputPrice.addEventListener is not a functionが表示されています。

 

addEventListenerエラー

 

このエラー文は、inputPrice.addEventListener は関数ではないという意味です。inputPrice には addEventListener というメソッドがなく、inputPrice.addEventListener の中身は undefined(値がない状態)です。それを関数として呼び出したため、エラーになっています。

HTMLCollection には addEventListener がない

document.getElementsByClassName() が返すのは、要素そのものではなく、一致した要素をまとめた HTMLCollection(HTMLコレクション)という1つのオブジェクトです。HTMLCollection は inputPrice[0] のように番号で中の要素を取り出せる集まりで、それ自体は addEventListener メソッドを持っていません。

 

addEventListener は、要素などの1つの対象に対して呼び出すメソッドです。そのため、getElementsByClassName で取得した集まりには、addEventListener を直接使えません。

 

同じことは querySelectorAll() でも起きます。querySelectorAll() が返す NodeList も要素の集まりなので、そのまま addEventListener を付けると同じエラーが出ます。

 

取得した中身を確かめるには、addEventListener の1行前に console.log(inputPrice); を足しましょう。コンソールに HTMLCollection や NodeList と表示されたら、要素の集まりを取得しています。

 

なお、このコードでは totalPrice も getElementsByClassName で取得しています。inputPrice だけを直すと、エラーは消えても税込金額は表示されません。totalPrice も同じように直しましょう。

直し方1:querySelector で1つだけ取得する

以下の通り、item_price クラスと total_price クラスの値を取得する際に、querySelector を使用すると、正しく表示されます。

 

<!DOCTYPE html>
<html lang="ja">

<head>
 <meta charset="UTF-8">
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 <title>税込価格を表示</title>
 <style>
  input {
    width: 200px;
    font-size: 16px;
    padding: 8px;
    margin-bottom: 8px;
   }
  </style>
</head>
<body>
 <input type="number" class="item_price" placeholder="金額を入力してください">
 <div class="total_price"></div>
 <script>
  const inputPrice = document.querySelector(".item_price");
  const totalPrice = document.querySelector(".total_price");
  inputPrice.addEventListener('input', function () {
    if (inputPrice.value === '') {
        totalPrice.textContent = '';
        return;
    }
  const taxRate = 0.1;
  totalPrice.textContent = `税込価格: ${(inputPrice.value * (1 + taxRate)).toFixed(2)} 円`;
  });
  </script>
</body>
</html>

 

税込計算after

 

querySelector() とは、指定されたCSSセレクタに一致する最初のHTML要素を取得するメソッドです。単一の要素が取得されることから、直接 addEventListener を適用できます。

直し方2:ID を付けて getElementById で取得する

以下の通り、item_price と total_price をクラスではなく id に設定し、getElementById() で id の要素を取得すると、正しく表示されます。

 

<!DOCTYPE html>
<html lang="ja">
<head>
 <meta charset="UTF-8">
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 <title>税込価格を表示</title>
 <style>
  input {
    width: 200px;
    font-size: 16px;
    padding: 8px;
    margin-bottom: 8px;
   }
  </style>
</head>
<body>
 <input type="number" id="item_price" placeholder="金額を入力してください">
 <div id="total_price"></div>
 <script>
  const inputPrice = document.getElementById("item_price");
  const totalPrice = document.getElementById("total_price");
  inputPrice.addEventListener('input', function () {
    if (inputPrice.value === '') {
        totalPrice.textContent = '';
        return;
    }
  const taxRate = 0.1;
  totalPrice.textContent = `税込価格: ${(inputPrice.value * (1 + taxRate)).toFixed(2)} 円`;
  });
  </script>
</body>
</html>

 

税込計算after

 

HTML文書内で要素に付けられるIDは単一であり、重複してはいけません。もし同じIDが複数の要素で使われている場合、メソッドは最初に見つかった要素を返します。

 

このように単一の要素が取得されることから、直接 addEventListener を適用できるのです。

Cannot read properties of null が出るときは、要素を取得できていない

コンソールに下のエラー文が表示されるときは、addEventListener を付けようとした変数の中身が null(何も入っていない状態)です。

 

Uncaught TypeError: Cannot read properties of null (reading 'addEventListener')

 

querySelector() や getElementById() は、一致する要素が見つからないと null を返します。その null に addEventListener を呼び出したため、エラーになっています。

 

確かめるには、addEventListener の1行前に console.log(inputPrice); を足しましょう。コンソールに null と表示されたら、要素を取得できていません。

script が HTML より先に実行されている

script を head の中に書くと、input などの要素より先に実行されます。script は、書かれた位置まで HTML を読んだところですぐに実行されるので、その時点では body の中の要素がまだなく、querySelector() が null を返します。

 

<!DOCTYPE html>
<html lang="ja">
<head>
 <meta charset="UTF-8">
 <title>税込価格を表示</title>
 <script>
  const inputPrice = document.querySelector(".item_price");
  const totalPrice = document.querySelector(".total_price");
  inputPrice.addEventListener('input', function () {
    if (inputPrice.value === '') {
        totalPrice.textContent = '';
        return;
    }
    const taxRate = 0.1;
    totalPrice.textContent = `税込価格: ${(inputPrice.value * (1 + taxRate)).toFixed(2)} 円`;
  });
 </script>
</head>
<body>
 <input type="number" class="item_price" placeholder="金額を入力してください">
 <div class="total_price"></div>
</body>
</html>

 

税込金額を表示させるには、次のどれかに書き換えましょう。

 

1つ目は、script を body の閉じタグの直前に移す方法です。直し方1・直し方2のコードは、この書き方になっています。

 

2つ目は、JavaScript を別のファイル(ここでは main.js)に分けて、defer を付けて読み込む方法です。defer を付けた script は、HTML を最後まで読み込んだ後に実行されます。

 

<script src="main.js" defer></script>

 

defer は、src で別のファイルを読み込む script にだけ効きます。head の中に直接書いた script に付けても、実行のタイミングは変わりません。

 

3つ目は、head の中に書いたまま、処理を DOMContentLoaded のイベントの中に入れる方法です。DOMContentLoaded は、HTML を最後まで読み込んだときに発生するイベントです。

 

<head>
 <meta charset="UTF-8">
 <title>税込価格を表示</title>
 <script>
  //HTMLを最後まで読み込んでから、中の処理を実行する
  document.addEventListener('DOMContentLoaded', function () {
    const inputPrice = document.querySelector(".item_price");
    const totalPrice = document.querySelector(".total_price");
    inputPrice.addEventListener('input', function () {
      if (inputPrice.value === '') {
          totalPrice.textContent = '';
          return;
      }
      const taxRate = 0.1;
      totalPrice.textContent = `税込価格: ${(inputPrice.value * (1 + taxRate)).toFixed(2)} 円`;
    });
  });
 </script>
</head>

 

HTML ファイル1つで書いているなら、書く場所を変えるだけで済む1つ目を使いましょう。

ID やクラス名を書き間違えている

script の位置が正しくても、querySelector() や getElementById() に渡した名前が HTML と1文字でも違うと、要素は見つからず null になります。HTML と見比べて、次の点を確かめましょう。

 

  • アンダースコア「_」とハイフン「-」を取り違えていないか(HTML の item_price に対して、.item-price と書いている)
  • 大文字と小文字が合っているか(.Item_price では見つからない)
  • querySelector() で、クラス名の前に「.」、ID の前に「#」を付けているか
  • getElementById() に渡す ID の前に、「#」を付けていないか

エラーが出ずに効かないときは、どの要素にいくつ登録したかを確かめる

コンソールに何も表示されないのに効かないときは、操作した要素にリスナーを登録できているか、同じイベントに処理を2つ登録していないかを確かめましょう。

querySelector で取得すると、2つ目以降の要素には登録されない

以下の通り、HTMLで価格を入力する欄を追加したとき、下段のボックスに数値を入力しても税込金額が表示されません。

 

<!DOCTYPE html>
<html lang="ja">
<head>
 <meta charset="UTF-8">
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 <title>税込価格を表示</title>
 <style>
  input {
    width: 200px;
    font-size: 16px;
    padding: 8px;
    margin-bottom: 8px;
  }
 </style>
</head>
<body>
 <div class="price">
  <p>価格1</p>
  <input type="number" class="item_price" placeholder="金額を入力してください">
  <div class="total_price"></div>
 </div>
 <div class="price">
   <p>価格2</p>
   <input type="number" class="item_price" placeholder="金額を入力してください">
   <div class="total_price"></div>
 </div>
 <script>
  const inputPrice = document.querySelector(".item_price");
  const totalPrice = document.querySelector(".total_price");
  inputPrice.addEventListener('input', function () {
    if (inputPrice.value === '') {
        totalPrice.textContent = '';
        return;
    }
      const taxRate = 0.1;
      totalPrice.textContent = `税込価格: ${(inputPrice.value * (1 + taxRate)).toFixed(2)} 円`;
  });
 </script>
</body>
</html>

 

2段入力before

 

querySelector() は、一致する要素のうち最初の1つだけを取得するメソッドです。そのため、addEventListener は上段の入力欄にだけ登録され、下段の入力欄には何も登録されていません。エラーにはならないので、コンソールには何も表示されません。

 

そこで、以下の通りJavaScriptを入力します。

 

<script>
 const prices = document.querySelectorAll(".price");
 prices.forEach(price => {
    const inputPrice = price.querySelector(".item_price");
    const totalPrice = price.querySelector(".total_price");
    inputPrice.addEventListener('input', function () {
        if (inputPrice.value === '') {
            totalPrice.textContent = '';
            return;
        }
        const taxRate = 0.1;
        totalPrice.textContent = `税込価格: ${(inputPrice.value * (1 + taxRate)).toFixed(2)} 円`;
    });
 });
</script>

 

まずは、querySelectorAll() で、price クラスに一致するすべての要素を取得します。続く forEach() は NodeList のメソッドで、取得した要素それぞれに以下の処理を繰り返すためのものです。

 

  • priceクラス内の”item_price”の要素を取得して、”inputPrice”と定義する
  • priceクラス内の”total_price”の要素を取得して、”totalPrice”と定義する
  • “item_price” クラスに値が入力されたときの処理を、addEventListenerで指定

 

これで、価格1と価格2の両方に正しい税込価格が表示されるようになります。

 

2段入力after

後から追加した要素には、最初に登録したリスナーが付かない

ボタンを押して価格の欄を増やすなど、ページを開いた後に JavaScript で追加した要素でも、同じことが起きます。querySelectorAll() と forEach() でリスナーを登録した時点では、追加する欄はまだありません。そのため、追加した欄に入力しても税込金額は表示されず、エラーも出ません。

 

この場合は、欄をまとめて入れている親の要素に、リスナーを1つだけ登録しましょう。イベントの委譲と呼ばれる書き方です。入力のイベントは、入力した欄から親の要素へと順に伝わるので、後から追加した欄の入力も親の要素で受け取れます。

 

<div id="price_list">
 <div class="price">
  <p>価格1</p>
  <input type="number" class="item_price" placeholder="金額を入力してください">
  <div class="total_price"></div>
 </div>
</div>
<button id="add_button">価格の欄を追加</button>
<script>
 const priceList = document.getElementById("price_list");
 //親の要素(#price_list)に、入力のリスナーを1つだけ登録する
 priceList.addEventListener('input', function (event) {
    //入力された要素が item_price クラスでなければ、何もしない
    if (!event.target.matches(".item_price")) return;
    const inputPrice = event.target;
    //入力された欄を囲む .price を探し、その中の total_price を取得する
    const totalPrice = inputPrice.closest(".price").querySelector(".total_price");
    if (inputPrice.value === '') {
        totalPrice.textContent = '';
        return;
    }
    const taxRate = 0.1;
    totalPrice.textContent = `税込価格: ${(inputPrice.value * (1 + taxRate)).toFixed(2)} 円`;
 });
 //ボタンを押すと、価格の欄を1つ追加する
 document.getElementById("add_button").addEventListener('click', function () {
    const price = document.createElement("div");
    price.className = "price";
    price.innerHTML = '<p>追加した価格</p><input type="number" class="item_price" placeholder="金額を入力してください"><div class="total_price"></div>';
    priceList.appendChild(price);
 });
</script>

event.target に入るのは、入力が行われた欄です。まず matches() で、その欄が item_price クラスかを確かめます。続く closest() が探すのは、その欄を囲んでいる price クラスの要素です。最後に querySelector() で、その要素の中にある total_price を取得しています。

同じイベントに2つ登録すると、後に登録した処理の表示が残る

以下の通り、ダブルクリックした際に入力金額が消去される動作を2つ追加します。

 

  1. 入力した価格と税込価格の欄を消去する
  2. 入力した価格を消去したあとに、税込価格の欄に「金額がクリアされました!」と表示する

 

<script>
 const prices = document.querySelectorAll(".price");
 prices.forEach(price => {
    const inputPrice = price.querySelector(".item_price");
    const totalPrice = price.querySelector(".total_price");
    inputPrice.addEventListener('input', function () {
        if (inputPrice.value === '') {
            totalPrice.textContent = '';
            return;
        }
    const taxRate = 0.1;
    totalPrice.textContent = `税込価格: ${(inputPrice.value * (1 + taxRate)).toFixed(2)} 円`;
    });
    //金額が消去された後は、何も表示されない
    inputPrice.addEventListener('dblclick', function () {
        inputPrice.value = '';
        totalPrice.textContent = '';
    });
    //金額が消去された後に、「金額がクリアされました!」と表示
    inputPrice.addEventListener('dblclick', function () {
        inputPrice.value = '';
        totalPrice.textContent = '金額がクリアされました!';
    });
 });
</script>

 

すると、ダブルクリックしたときに①と②の両方が実行され、税込価格の欄に残るのは「金額がクリアされました!」です。①の処理は動いていますが、すぐ後に②が同じ欄を書き換えるので、①が効いていないように見えてしまいます。

 

同じ要素の同じイベントに登録したリスナーは、登録した順にすべて実行されます。後から登録したリスナーが、先に登録したリスナーを上書きすることはありません。

 

税込計算:ダブルクリック

 

ダブルクリックしたときの処理は、1つのリスナーにまとめましょう。下のコードは、①の処理だけを残した例です。「金額がクリアされました!」と表示したい場合は、残したリスナーで totalPrice.textContent に入れている文字を「金額がクリアされました!」に書き換えます。

 

<script>
 const prices = document.querySelectorAll(".price");
 prices.forEach(price => {
    const inputPrice = price.querySelector(".item_price");
    const totalPrice = price.querySelector(".total_price");
    inputPrice.addEventListener('input', function () {
        if (inputPrice.value === '') {
            totalPrice.textContent = '';
            return;
        }
    const taxRate = 0.1;
    totalPrice.textContent = `税込価格: ${(inputPrice.value * (1 + taxRate)).toFixed(2)} 円`;
    });
    inputPrice.addEventListener('dblclick', function () {
        inputPrice.value = '';
        totalPrice.textContent = '';
    });
 });
</script>

まとめ

addEventListener が効かない原因は、コンソールに表示されるエラー文で絞り込めます。まずは、効かない addEventListener の1行前に console.log を1行足して、取得した変数に何が入っているかを表示してみてください。