本記事では、JavaScriptのaddEventListenerメソッドで登録したイベントを削除する方法について解説しています。
- 誰でも分かるように嚙み砕いて説明してくれる
- アニメーションの知識が深く学べる
- 1つのWebサイトを作りながら学べる
ポチップ
先輩くんAmazon Kindle Unlimitedに登録すると、月額980円で読み放題だからオススメだよ！
後輩ちゃん初回30日間は無料だから、まだ登録したことのない人はぜひ試してみてね！
変数名/関数名にもう悩まない！
- 美しいコードが書けるが自然と書けるようになる
- 他の開発者が理解しやすいコードになる
ポチップ
removeEventListenerメソッド
一度設定したイベントリスナーを削除したい場合は、removeEventListenerメソッドを使用します。基本的な使い方は以下のとおりです。
removeEventListener(type, listener, useCapture);- type：イベントの種類を指定
- listener：イベント発生時に処理をしたいコードを記述
- useCapture：キャプチャフェーズまたはバブリングフェーズの選択(省略可能：デフォルト値はfalse)
removeEventListenerメソッドの引数は、イベント登録で使い慣れているaddEventListenerメソッドと全く同じと思って頂いて問題ないです。
実際に、addEventListenerメソッドを使用して登録したイベントリスナーを削除するサンプルコードを用意したので、動作確認してみましょう。
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
</head>
<body>
<input id="btn" type="button" value="ボタン" />
<script src="index.js"></script>
</body>
</html>let btn = document.querySelector("#btn");
const callLog = () => console.log("ボタンがクリックされました！");
btn.addEventListener("click", callLog, false);上記のコードは、現状ボタンをクリックするとコンソールログに「ボタンがクリックされました！」の文字が出力されます。最後の行に下記のremoveEventListenerメソッドを追加してみます。
btn.removeEventListener("click", callLog, false);すると、ボタンをクリックしてもコンソールログに何も表示がされなくなります。これで設定したイベントが削除されたことが確認できました。
removeEventListenerメソッドの注意点
removeEventListenerメソッドを使う注意点は2つあります。
1つ目は、addEventListenerメソッドでイベントが定義された後に記述する必要があります。下記のコードのように、定義される前に記述をした場合は削除対象のイベントが見つからないと判断されてしまいます。
btn.removeEventListener("click", callLog, false); // => イベント削除のコード
btn.addEventListener("click", callLog, false); // => イベント登録のコード2つ目は、第三引数のboolean値を必ず同じにすることです。下記のコードのようにaddEventListenerメソッドではfalseを指定し、removeEventListenerメソッドではtrueを指定した場合は異なるイベントだと判断され削除がされません。
btn.addEventListener("click", callLog, false);
btn.removeEventListener("click", callLog, true);
