javascript addEventListenerで設定したイベントを削除する

作成日 2022.03.23
更新日 2022.10.27
javascript
javascript

javascriptで、addEventListenerで設定したイベントを削除するサンプルコードを記述してます。「removeEventListener」を使用すれば削除は可能です。また「addEventListener」ではなく「onclick」などは削除の方法が異なります。

1. 環境
2. イベントを削除
3. onの場合
4. サンプルコード

環境

OS windows11 home
Apache 2.4.43
ブラウザ chrome 107.0.5304.63

Javascript サンプル集はこちら

イベントを削除

イベントを削除する場合は「removeEventListener」を使用します。

ターゲット名.removeEventListener(イベント名,コールバック関数)

実際に、イベントを登録して削除してみます。

document.getElementByIdの省略して記述する

<button id="btn1">ボタン</button>
<button id="btn2" onclick="hoge()">除去</button>

<script>

// イベントで実行する関数
function foo(){ console.log('foo') }

// イベント登録
btn1.addEventListener('click', foo);  

// イベントを除去
function hoge(){
  btn1.removeEventListener('click', foo)
}

</script>

実行結果

ボタンに設定されてクリックイベントが削除されていることが確認できます。

また、addEventListener()の第三引数である「useCapture」の値が異なる場合は「removeEventListener」は機能しません。

function foo(){ console.log('foo') }

btn1.addEventListener('click', foo, true); 

function hoge(){
  btn1.removeEventListener('click', foo, false)
}

無名関数やアロー関数も、コールバック関数が指定できないため「removeEventListener」は機能しません。

window.onload = function(){
  btn1.addEventListener('click', function(e){console.log('foo')});  
}

function hoge(){
  btn1.removeEventListener('click', function(e){console.log('foo')})
}

onの場合

「on」を使用した場合は、値を「null」にすることで削除できます。

<button id="btn1">ボタン</button>
<button id="btn2" onclick="hoge()">除去</button>

<script>

document.getElementById("btn1").onclick = function (){ 
    console.log('foo')    
}

function hoge(){
    document.getElementById("btn1").onclick = null
}

</script>

addEventListenerとonの違い

サンプルコード

以下は、
「実行」ボタンを登録されたイベントを、5秒後に削除するサンプルコードとなります。

※cssには「tailwind」を使用して、アロー関数で関数は定義してます。

アロー関数の使い方

document.getElementByIdの省略して記述する

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

<head>
  <meta charset="utf-8">
  <title>mebeeサンプル</title>
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <script src="https://cdn.tailwindcss.com"></script>
</head>

<script>

  let count = 0

  const hoge = () => { count++; foo.innerHTML = count + "回クリックされました" }

  window.onload = () => {

    btn.addEventListener('click', hoge);

  }

  // 5秒後にイベントを削除
  setTimeout(function () {    
    btn.removeEventListener('click', hoge);
    foo.innerHTML = "clickイベントは削除されました"
  }, 5000);

</script>

<body>
  <div class="container mx-auto my-56 w-64 px-4">

    <div id="sample" class="flex flex-col justify-center">

      <h1 class="font-semibold text-neutral-500 text-lg mr-auto">実行結果</h1>

      <p id="foo" class="font-semibold text-lg mr-auto"></p>

      <button id="btn"
        class="mb-2 md:mb-0 bg-transparent hover:bg-pink-500 text-pink-700 font-semibold hover:text-white py-2 px-4 border border-pink-500 hover:border-transparent rounded">
        実行
      </button>

    </div>

  </div>
</body>

</html>

実行結果を確認すると、削除されていることが確認できます。