JavaScriptのeventにおける非推奨メソッドの代替案13選

JavaScriptのeventにおける非推奨メソッドの代替案を解説!JS
この記事は約26分で読めます。

 

【サイト内のコードはご自由に個人利用・商用利用いただけます】

この記事では、プログラムの基礎知識を前提に話を進めています。

説明のためのコードや、サンプルコードもありますので、もちろん初心者でも理解できるように表現してあります。

基本的な知識があればカスタムコードを使って機能追加、目的を達成できるように作ってあります。

※この記事は、一般的にプロフェッショナルの指標とされる『実務経験10,000時間以上』を凌駕する現役のプログラマチームによって監修されています。

サイト内のコードを共有する場合は、参照元として引用して下さいますと幸いです

※Japanシーモアは、常に解説内容のわかりやすさや記事の品質に注力しております。不具合、分かりにくい説明や不適切な表現、動かないコードなど気になることがございましたら、記事の品質向上の為にお問い合わせフォームにてご共有いただけますと幸いです。
(送信された情報は、プライバシーポリシーのもと、厳正に取扱い、処分させていただきます。)

●JavaScriptのイベントとは?

JavaScriptで、イベントは主役級の存在です。

ユーザーがボタンをクリックしたり、キーボードを叩いたり、マウスを動かしたりといった一連の操作は、すべてイベントとして扱われます。

また、ページが読み込まれた瞬間や、フォームが送信された時なども、イベントに含まれます。

○イベントの種類と役割

イベントには、大きく分けて2つの種類があります。ひとつは、ユーザーの操作に応じて発生するイベント。

もうひとつは、ブラウザやDOMの状態変化に伴って自動的に発生するイベントです。

前者の例としては、click、keydown、mousemoveなどが挙げられ、後者の例としては、load、submit、resizeなどがあります。

このイベントを適切に処理することで、Webアプリケーションはユーザーとのインタラクションを実現し、動的で魅力的なユーザーエクスペリエンスを提供できるのです。

○イベントハンドラとイベントリスナーの違い

イベントを処理する方法には、イベントハンドラとイベントリスナーの2つのアプローチがあります。

イベントハンドラは、HTMLタグのonclick属性などを使って直接要素に割り当てる方法です。

一方、イベントリスナーは、addEventListener()メソッドを使ってJavaScriptコード内で要素にイベント処理を登録する方法です。

両者の大きな違いは、イベントリスナーでは複数の処理を同じイベントに対して登録できるのに対し、イベントハンドラでは1つの処理しか割り当てられないことです。

また、イベントリスナーの方が、コードの可読性や保守性の面で優れています。

○非推奨のイベントメソッドとは

かつてのJavaScriptでは、イベントを処理するためにいくつかの非推奨メソッドが使われていました。

例えば、Element.attachEvent()やElement.detachEvent()は、Internet Explorer特有のメソッドで、他のブラウザでは使えません。

また、HTMLタグのonclick属性などのイベントハンドラも、コードの柔軟性や再利用性の面で制約があるため、現在では非推奨とされています。

この古い手法を使っていると、ブラウザの互換性問題に悩まされたり、コードの保守性が低下したりする恐れがあります。

そのため、モダンなJavaScriptではaddEventListener()を使ったイベントリスナーが推奨されています。

●addEventListener()の使い方

さて、非推奨のイベントメソッドに別れを告げたところで、今度はモダンなイベント処理の方法を身につけていきましょう。

現代のJavaScriptで最も推奨されているのが、addEventListener()を使ったイベントリスナーの登録です。

このメソッドを使えば、要素に対して複数のイベント処理を柔軟に割り当てることができます。

addEventListener()の基本的な使い方は、下記のような感じです。

要素.addEventListener(イベント種類, 処理関数, オプション);

第1引数にはイベントの種類を文字列で指定し、第2引数には処理を担当する関数を渡します。

第3引数はオプションで、イベントの伝播方法などを制御できます。

では、実際のコードを見ていきましょう。

○サンプルコード1:クリックイベントの割り当て

まずは、よくあるクリックイベントの処理です。

ボタンがクリックされたら、アラートを表示するという単純な例です。

<button id="myButton">クリックしてね</button>
const button = document.getElementById('myButton');

button.addEventListener('click', function() {
  alert('ボタンがクリックされました!');
});

ここでは、buttonという変数にボタン要素を取得し、それに対してaddEventListener()でクリックイベントのリスナーを登録しています。

無名関数を使って、アラートを表示する処理を定義しているのがポイントです。

このように、addEventListener()を使えば、HTMLとJavaScriptを分離して、よりクリーンなコードを書くことができます。

○サンプルコード2:複数のイベントリスナーの追加

次に、同じ要素に対して複数のイベントリスナーを登録する例を見てみましょう。

<input type="text" id="myInput">
const input = document.getElementById('myInput');

input.addEventListener('focus', function() {
  console.log('フォーカスを得ました');
});

input.addEventListener('blur', function() {
  console.log('フォーカスを失いました');
});

input.addEventListener('input', function() {
  console.log('入力値が変化しました:', this.value);
});

ここでは、テキスト入力欄に対して、focusイベント(フォーカスを得た時)、blurイベント(フォーカスを失った時)、inputイベント(入力値が変化した時)の3つのリスナーを登録しています。

それぞれの処理関数の中では、コンソールにログを出力しています。

inputイベントのリスナーでは、this.valueで現在の入力値を参照しているのがミソです。

このように、addEventListener()を使えば、1つの要素に対して複数の処理を柔軟に割り当てられるのが大きな利点です。

もし同じことをイベントハンドラでやろうとすると、コードが複雑になってしまいます。

○サンプルコード3:イベントリスナーの削除

最後に、登録したイベントリスナーを削除する方法を見ておきましょう。

<button id="addListener">リスナーを追加</button>
<button id="removeListener">リスナーを削除</button>
<button id="clickMe">クリックしてね</button>
const addButton = document.getElementById('addListener');
const removeButton = document.getElementById('removeListener');
const clickButton = document.getElementById('clickMe');

function handleClick() {
  alert('クリックされました!');
}

addButton.addEventListener('click', function() {
  clickButton.addEventListener('click', handleClick);
  console.log('リスナーを追加しました');
});

removeButton.addEventListener('click', function() {
  clickButton.removeEventListener('click', handleClick);
  console.log('リスナーを削除しました');
});

ここでは、「リスナーを追加」ボタンがクリックされたら、「クリックしてね」ボタンにクリックイベントのリスナーを登録し、「リスナーを削除」ボタンがクリックされたら、そのリスナーを削除するという流れになっています。

リスナーの削除には、removeEventListener()メソッドを使います。

この時、登録時と同じイベント種類と処理関数を指定する必要があります。

そのため、上記の例では、handleClick()という名前付き関数を定義して使っています。

イベントリスナーの削除は、不要になったイベント処理を解放してメモリリークを防ぐのに役立ちます。

また、動的にイベント処理を切り替えたい場合にも使えるテクニックです。

●イベントオブジェクトの活用

イベントリスナーを使いこなせるようになったら、次はイベントオブジェクトを活用する方法を身につけましょう。

イベントオブジェクトとは、イベントが発生した時に自動的に生成されるオブジェクトで、イベントに関する様々な情報を持っています。

このオブジェクトを上手に利用することで、より柔軟で高度なイベント処理が可能になります。

イベントオブジェクトは、イベントリスナーの処理関数の第1引数として渡されます。

この引数は慣例的にeventやeと名付けられることが多いですが、好きな名前を付けることができます。

では、実際にイベントオブジェクトを使ってみましょう。

○サンプルコード4:イベントオブジェクトの取得

まずは、イベントオブジェクトを取得して、その中身を確認してみましょう。

<button id="myButton">クリックしてね</button>
const button = document.getElementById('myButton');

button.addEventListener('click', function(event) {
  console.log(event);
});

ここでは、クリックイベントのリスナー関数の引数にeventを指定しています。

ボタンをクリックすると、コンソールにイベントオブジェクトの中身が出力されます。

出力結果を見ると、type、target、timeStampなど、イベントに関する様々なプロパティが含まれていることがわかります。

これらのプロパティを使えば、イベントの詳細な情報を取得できます。

例えば、event.typeでイベントの種類を、event.targetでイベントが発生した要素を知ることができます。

この情報を活用することで、より柔軟なイベント処理が可能になるのです。

○サンプルコード5:イベントターゲットの特定

次に、イベントオブジェクトを使ってイベントが発生した要素(イベントターゲット)を特定する方法を見てみましょう。

<ul id="myList">
  <li>アイテム1</li>
  <li>アイテム2</li>
  <li>アイテム3</li>
</ul>
const list = document.getElementById('myList');

list.addEventListener('click', function(event) {
  if (event.target.tagName === 'LI') {
    console.log(event.target.textContent + 'がクリックされました');
  }
});

ここでは、リスト(ul要素)全体にクリックイベントのリスナーを設定しています。

リスト内の個々のアイテム(li要素)がクリックされた時、イベントオブジェクトのtargetプロパティを使ってクリックされた要素を特定しています。

具体的には、event.target.tagNameでクリックされた要素のタグ名を取得し、それが’LI’であれば、そのアイテムがクリックされたと判断しています。

そして、event.target.textContentでクリックされたアイテムのテキスト内容を取得し、コンソールに出力しています。

このように、イベントオブジェクトを使えば、イベントが発生した正確な位置を知ることができます。

これは、動的に生成された要素を扱う場合や、同じイベントリスナーを複数の要素に設定する場合に特に役立つテクニックです。

○サンプルコード6:イベントバブリングの制御

最後に、イベントオブジェクトを使ってイベントバブリングを制御する方法を見てみましょう。

イベントバブリングとは、ある要素で発生したイベントが、親要素に向かって順番に伝播していく仕組みのことです。

<div id="myDiv">
  <button id="myButton">クリックしてね</button>
</div>
const div = document.getElementById('myDiv');
const button = document.getElementById('myButton');

div.addEventListener('click', function() {
  console.log('div要素がクリックされました');
});

button.addEventListener('click', function(event) {
  console.log('button要素がクリックされました');
  event.stopPropagation();
});

ここでは、div要素とその中のbutton要素の両方にクリックイベントのリスナーを設定しています。

buttonをクリックすると、通常はbuttonのイベントが発生した後、親要素のdivに向かってイベントが伝播します(バブリングします)。

しかし、buttonのイベントリスナーの中で、event.stopPropagation()を呼び出すことで、このイベントバブリングを停止することができます。

これにより、buttonをクリックした時は、buttonのイベントだけが発生し、divのイベントは発生しなくなります。

イベントバブリングは便利な反面、意図しない動作を引き起こすこともあります。

イベントオブジェクトのstopPropagation()メソッドを使えば、必要に応じてバブリングを制御し、より細やかなイベント管理が可能になります。

イベントオブジェクトには他にも様々な便利なプロパティやメソッドがあります。

マウスイベントの座標を取得したり、キーボードイベントのキー情報を取得したりと、活用方法は多岐にわたります。

イベントオブジェクトを味方につけることで、JavaScriptでのイベント処理の幅がぐんと広がります。

●カスタムイベントの作成と発火

さて、ここまでは標準のイベントを使ったイベント処理について学んできました。

しかし、JavaScriptの世界はそれだけではありません。

なんと、自分で独自のイベントを作成し、発火させることもできるのです。

それがカスタムイベントです。

カスタムイベントを使えば、アプリケーション独自のイベントを定義し、コンポーネント間の疎結合なコミュニケーションを実現できます。

例えば、ある処理が完了した時に”processed”というカスタムイベントを発火させ、別の部分でそのイベントを監視して処理を実行する、といった具合です。

それでは、カスタムイベントの作成と発火の方法を見ていきましょう。

○サンプルコード7:カスタムイベントの定義

カスタムイベントを作成するには、CustomEventコンストラクターを使用します。

const myEvent = new CustomEvent('myEvent', {
  detail: {
    message: 'これは私のカスタムイベントです!'
  }
});

ここでは、’myEvent’という名前のカスタムイベントを作成しています。

第2引数のオプションオブジェクトで、イベントに関する追加情報を指定できます。

detailプロパティに任意のデータを設定すると、イベントリスナー側でそのデータを受け取ることができます。

このようにして作成したカスタムイベントは、dispatchEventメソッドを使って発火することができます。

○サンプルコード8:カスタムイベントの発火

では、先ほど作成したカスタムイベントを実際に発火させてみましょう。

const myElement = document.getElementById('myElement');
myElement.dispatchEvent(myEvent);

ここでは、myElementという要素に対して、myEventというカスタムイベントを発火させています。

dispatchEventメソッドに、発火させたいイベントオブジェクトを渡すだけです。

これで、myElement要素で’myEvent’イベントが発生したことになります。

後は、このイベントを監視するリスナーを設定すれば、イベント発生時に任意の処理を実行できます。

○サンプルコード9:カスタムイベントのリスナー登録

最後に、カスタムイベントを監視するリスナーを登録する方法を見てみましょう。

myElement.addEventListener('myEvent', function(event) {
  console.log(event.detail.message);
});

カスタムイベントのリスナー登録は、標準のイベントと同じようにaddEventListenerメソッドを使います。

第1引数にカスタムイベントの名前を、第2引数にリスナー関数を指定します。

リスナー関数の中では、イベントオブジェクトを通じてカスタムイベントのdetailプロパティにアクセスできます。

上記の例では、event.detail.messageでカスタムイベントに添付されたメッセージを取得し、コンソールに出力しています。

●よくあるエラーと対処法

JavaScriptのイベント処理を学んでいると、時々思わぬエラーに遭遇することがあります。

初心者の頃は特に、「なぜこのコードが動かないんだろう?」と頭を抱えることも多いでしょう。

でも、安心してください。エラーは成長のチャンスです。

ここでは、イベント処理でよく遭遇するエラーとその対処法を見ていきましょう。

きっとあなたの悩みも解決できるはずです。

○イベントリスナーが機能しない場合

「イベントリスナーを設定したのに、イベントが捕捉できない!」そんな経験はありませんか?

実は、このエラーには幾つかの典型的な原因があります。

まず考えられるのが、イベントリスナーを設定するタイミングの問題です。

DOMの読み込みが完了する前にイベントリスナーを設定しようとすると、対象の要素がまだ存在しないためエラーになります。

// NG: DOMの読み込み前にイベントリスナーを設定
document.getElementById('myButton').addEventListener('click', function() {
  console.log('クリックされました');
});

この問題を解決するには、DOMContentLoadedイベントを使ってDOMの読み込み完了を待つか、scriptタグをbody要素の最後に配置するのが一般的です。

// OK: DOMの読み込み完了を待ってからイベントリスナーを設定
document.addEventListener('DOMContentLoaded', function() {
  document.getElementById('myButton').addEventListener('click', function() {
    console.log('クリックされました');
  });
});

もう1つの可能性は、イベントリスナーを設定する要素の指定が間違っている場合です。

セレクターが間違っていたり、存在しないIDを指定したりすると、当然イベントは捕捉できません。

コンソールでエラーメッセージを確認し、要素の指定が正しいかどうかを入念にチェックしましょう。

○イベント発火のタイミングがずれる場合

「イベントは発火するけど、タイミングがおかしい!」という経験もあるかもしれません。

これは、非同期処理が絡んでいる場合に起こりやすい問題です。

例えば、ajaxでデータを取得した後にイベントを発火させたい場合、ajaxのコールバック関数の中でイベントを発火させる必要があります。

// NG: ajaxの処理が完了する前にイベントを発火
document.getElementById('myButton').addEventListener('click', function() {
  const xhr = new XMLHttpRequest();
  xhr.open('GET', '/api/data');
  xhr.send();

  // ajaxの処理が完了する前にイベントを発火
  const event = new CustomEvent('myEvent');
  document.dispatchEvent(event);
});
// OK: ajaxのコールバック関数の中でイベントを発火
document.getElementById('myButton').addEventListener('click', function() {
  const xhr = new XMLHttpRequest();
  xhr.open('GET', '/api/data');
  xhr.onload = function() {
    if (xhr.status === 200) {
      // ajaxの処理が完了してからイベントを発火
      const event = new CustomEvent('myEvent');
      document.dispatchEvent(event);
    }
  };
  xhr.send();
});

非同期処理の結果を待ってからイベントを発火させることで、データの整合性を保つことができます。

このように、コードの実行順序を意識することが、タイミングのずれを解消するカギになります。

○イベントバブリングによる予期せぬ動作

イベントバブリングは、イベント処理を柔軟に行う上で欠かせない仕組みです。

しかし、時にはバブリングが予期せぬ動作を引き起こすこともあります。

よくあるのが、子要素のイベントが親要素にまで伝播して、意図しない処理が実行されてしまうケースです。

<div id="parent">
  <button id="child">クリックしてね</button>
</div>
// 親要素のクリックイベント
document.getElementById('parent').addEventListener('click', function() {
  console.log('親要素がクリックされました');
});

// 子要素のクリックイベント
document.getElementById('child').addEventListener('click', function() {
  console.log('子要素がクリックされました');
});

この例では、子要素のボタンをクリックすると、子要素のイベントに加えて親要素のイベントまで発火してしまいます。

これが意図した動作でない場合は、イベントオブジェクトのstopPropagation()メソッドを使ってイベントの伝播を止める必要があります。

// 子要素のクリックイベント
document.getElementById('child').addEventListener('click', function(event) {
  event.stopPropagation(); // イベントの伝播を止める
  console.log('子要素がクリックされました');
});

このようにイベントバブリングをコントロールすることで、意図しない動作を防ぐことができます。

イベントの伝播をしっかり理解し、必要に応じてstopPropagation()を使い分けるのがポイントです。

●イベントを活用した応用例

さて、ここまでJavaScriptのイベント処理について基本から応用まで幅広く解説してきました。

理解が深まったところで、実際にイベントを活用した具体的な例を見ていきましょう。

イベント処理の知識を実践に移すことで、よりインタラクティブで魅力的なWebアプリケーションを作れるようになるはずです。

ここでは、フォーム送信時の入力チェック、スクロール位置に応じたアニメーション、ドラッグアンドドロップの実装、キーボードショートカットの割り当てという4つの応用例を取り上げます。

それぞれのサンプルコードを通して、イベント処理の実践的な活用方法を学んでいきましょう。

○サンプルコード10:フォーム送信時の入力チェック

フォームの入力値をチェックし、不備がある場合は送信を中止するのは、Webアプリケーションでよくある処理ですね。

これをイベント処理で実現してみましょう。

<form id="myForm">
  <label for="name">名前:</label>
  <input type="text" id="name" name="name" required>

  <label for="email">メールアドレス:</label>
  <input type="email" id="email" name="email" required>

  <button type="submit">送信</button>
</form>
const form = document.getElementById('myForm');

form.addEventListener('submit', function(event) {
  const nameInput = document.getElementById('name');
  const emailInput = document.getElementById('email');

  if (nameInput.value.trim() === '' || emailInput.value.trim() === '') {
    alert('名前とメールアドレスは必須項目です');
    event.preventDefault(); // フォーム送信をキャンセル
  }
});

ここでは、フォームのsubmitイベントにリスナーを登録し、送信ボタンがクリックされた時の処理を定義しています。

入力された名前とメールアドレスが空白ではないかチェックし、空白の場合はアラートを表示してフォームの送信をキャンセルしています。

event.preventDefault()を呼び出すことで、フォームの送信を中止することができます。

このように、submitイベントを活用することで、フォームの入力値チェックを簡単に実装できます。

○サンプルコード11:スクロール位置に応じたアニメーション

ページのスクロール位置に応じて要素をアニメーションさせると、ページに動きが出て印象的なデザインになります。

これをイベント処理で実現してみましょう。

<div id="box"></div>
#box {
  width: 100px;
  height: 100px;
  background-color: #f0f;
  position: fixed;
  top: 0;
  left: -100px;
  transition: left 0.3s;
}
window.addEventListener('scroll', function() {
  const box = document.getElementById('box');
  const scrollTop = window.pageYOffset || document.documentElement.scrollTop;

  if (scrollTop > 200) {
    box.style.left = '0';
  } else {
    box.style.left = '-100px';
  }
});

ここでは、ウィンドウのscrollイベントにリスナーを登録し、スクロール位置が200pxを超えた時にボックス要素を右から左へスライドインさせています。

スクロール位置は、window.pageYOffsetまたはdocument.documentElement.scrollTopで取得できます。

この値を使って条件分岐し、ボックス要素のCSSを動的に変更しています。

このように、scrollイベントを活用することで、スクロール位置に応じたインタラクティブなアニメーションを実装できます。

アニメーションの内容は、CSSのtransitionやtransformを使って自由にカスタマイズできるでしょう。

○サンプルコード12:ドラッグアンドドロップの実装

ドラッグアンドドロップは、直感的なユーザーインターフェースを提供する上で欠かせない機能です。

これをイベント処理で実現してみましょう。

<div id="dragBox" draggable="true">ドラッグしてね</div>
<div id="dropBox">ここにドロップしてね</div>
#dragBox {
  width: 100px;
  height: 100px;
  background-color: #ff0;
  display: inline-block;
  margin-right: 20px;
}

#dropBox {
  width: 200px;
  height: 200px;
  border: 2px dashed #999;
  display: inline-block;
}
const dragBox = document.getElementById('dragBox');
const dropBox = document.getElementById('dropBox');

dragBox.addEventListener('dragstart', function(event) {
  event.dataTransfer.setData('text/plain', event.target.id);
});

dropBox.addEventListener('dragover', function(event) {
  event.preventDefault();
});

dropBox.addEventListener('drop', function(event) {
  event.preventDefault();
  const draggedId = event.dataTransfer.getData('text');
  const draggedElement = document.getElementById(draggedId);
  event.target.appendChild(draggedElement);
});

ここでは、dragstartイベント、dragoverイベント、dropイベントを使ってドラッグアンドドロップを実装しています。

dragstartイベントでは、ドラッグされる要素のIDをDataTransferオブジェクトにセットしています。

dragoverイベントでは、ドロップを許可するために、event.preventDefault()を呼び出しています。

dropイベントでは、ドロップされた要素のIDをDataTransferオブジェクトから取得し、ドロップ先の要素に appendChild()で追加しています。

このように、ドラッグアンドドロップに関連するイベントを適切に処理することで、ユーザーが直感的に操作できるインターフェースを実現できます。

○サンプルコード13:キーボードショートカットの割り当て

キーボードショートカットは、ユーザーの生産性を高める上で重要な機能です。

これをイベント処理で実現してみましょう。

document.addEventListener('keydown', function(event) {
  if (event.ctrlKey && event.key === 's') {
    event.preventDefault();
    console.log('保存しました');
  }
});

ここでは、ドキュメント全体のkeydownイベントにリスナーを登録し、Ctrlキーと「s」キーが同時に押された時の処理を定義しています。

event.ctrlKeyでCtrlキーが押されているかを判定し、event.keyで押されたキーを判定しています。

条件に一致した場合は、event.preventDefault()でブラウザのデフォルトの動作をキャンセルし、代わりに独自の処理(ここではコンソールにメッセージを出力)を実行しています。

まとめ

JavaScriptのイベント処理は、Webアプリケーションにインタラクティブ性を付与する上で欠かせない技術です。

addEventListener()を始めとするモダンなイベントハンドリングの手法を身につけ、イベントオブジェクトやカスタムイベントを活用することで、より洗練されたユーザーエクスペリエンスを提供できるでしょう。

本チュートリアルで学んだ知識を土台に、さらなる探求と創意工夫を重ねていってください。

皆さんがこれからも成長を続け、ユーザーを喜ばせるようなアプリケーションを開発されることを心から願っています。