JavaScript

【JavaScript】イベント伝搬を即時に止める方法

本記事では、イベント伝搬を即時に止める方法について解説しています。

この方法を覚えることで、JavaScriptで1つの要素に対して同じイベントが複数ある場合にイベント伝搬を即時に止め他のイベントを実行させないようにすることが出来るようになります。

JavaScriptの学習におすすめ参考書
改訂3版JavaScript本格入門 ~モダンスタイルによる基礎から現場での応用まで

本書情報
出版社技術評論社
著者山田 祥寛
発売日2023/2/13
ページ数624ページ
レビュー
(Amazon)
(4件)
先輩くん
先輩くん
10万部突破したJavaScriptの本が大幅増補改訂し7年ぶりに発売されたよ!
後輩ちゃん
後輩ちゃん
最新の基本文法から、開発に欠かせない応用トピックまで学ぶことが出来るよ!

綺麗なコードが書けるようになる!
リーダブルコード-より良いコードを書くためのシンプルで実践的なテクニック

本書情報
出版社オライリージャパン
著者Dustin Boswell / Trevor Foucher
発売日2012/6/23
ページ数260ページ
レビュー
(Amazon)
(620件)
先輩くん
先輩くん
より良いコードを書きたい人におすすめの本だよ!
後輩ちゃん
後輩ちゃん
10以上前の書籍ですが、内容は今でも役に立つものばかりです!

stopImmediatePropagationメソッドの使い方

イベント伝搬を即時に止めるには、stopImmediatePropagationメソッドを使用します。基本的な使い方は以下のとおりです。

const listener= (e) => {
  e.stopImmediatePropagation();
};

btn.addEventListener(type, listener, useCapture);

イベントの処理が記述されている関数に引数を設定し、「引数.stopImmediatePropagation()」で使うことが出来ます。

stopImmediatePropagationメソッドと使い方が似ているstopPropagationメソッドがありますが、親要素や祖先要素にイベント伝搬するのをキャンセルさせるためのメソッドなので同じ要素に複数のイベントが設定されている時はそれらをすべて実行します。

実際に、stopImmediatePropagationメソッドを使用したサンプルコードを用意したので、動作確認してみましょう。

<!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 btnClick1 = () => {
  console.log("1つめのイベントが実行されました!");
};

const btnClick2 = () => {
  console.log("2つめのイベントが実行されました!");
};

btn.addEventListener("click", btnClick1, false);
btn.addEventListener("click", btnClick2, false);

/* コンソールログ *
 * 
 * 1つめのイベントが実行されました!
 * 2つめのイベントが実行されました!
 * 
 */

上記のコードは、現状ボタンをクリックすると2つのイベントが実行され、コンソールログに「1つめのイベントが実行されました!」「2つめのイベントが実行されました!」が出力されます。

stopImmediatePropagationメソッドを追加して、再度ボタンをクリックしてみましょう。

const btnClick1 = (e) => {
  e.stopImmediatePropagation();
  console.log("1つめのイベントが実行されました!");
};

/* コンソールログ *
 * 
 * 1つめのイベントが実行されました!
 * 
 */

すると、コンソールログには「1つめのイベントが実行されました!」のみ出力されます。これで、イベント伝搬が即時キャンセルされ後続で待っているイベント処理が実行されないことが分かりました。

ブログランキング・にほんブログ村へ PVアクセスランキング にほんブログ村