Escキーのキーコード

Escはevent.key「Escape」、event.code「Escape」、keyCode 27を送ります。

すべての値の一覧

Escapeの値
キーevent.codeevent.keykeyCodeevent.location
EscEscapeEscape270(標準)

keyCodeは、WindowsのChromeとEdgeが送る値です。Macの列(MacのChromeとSafari)とFirefoxの列には、違う数値だけを表示しています。システムによって違うキーもあり、下の説明に書いています。event.whichは、いつもkeyCodeと同じ数値です。event.keyは、US配列でShiftなしの値です。

ここで押してみる

ここをクリックしてから、Escapeを押してください

キーボードだけで操作していますか?キーの枠から出るには、Escを押してからTabを押してください。

Escapeに反応するコード

おすすめ:event.keyで判定
document.addEventListener('keydown', (event) => {
  if (event.key === 'Escape') {
    // ここに処理を書きます
  }
});
キーの位置で判定:event.code
document.addEventListener('keydown', (event) => {
  if (event.code === 'Escape') {
    // ここに処理を書きます
  }
});
keyCodeを使う古いコード(非推奨)
document.addEventListener('keydown', (event) => {
  if (event.keyCode === 27) {
    // ここに処理を書きます
  }
});

どの値を使うか

event.key === 'Escape'を確かめます。Escキーは1つだけで、どの配列でも同じ値を送ります。そのため、ここではevent.keyとevent.codeは同じ内容です。読みやすいのはkeyです。

keyCode 27はどのブラウザでもまだ届きますが、非推奨です。

とても古いブラウザ(Internet ExplorerとFirefox 36以前)は、代わりに"Esc"を送っていました。両方を受け付けるのは、それらにまだ対応する場合だけで十分です。

よくあるつまずき

Escで全画面表示が終わり、ハンドラーで止められない

全画面表示(とポインターロック)の間、Escはブラウザのものです。必ず全画面表示が終わり、preventDefault()も効きません。ハンドラーにそのEscが届かないこともあります。いつ終わったかを知るには、fullscreenchangeを受け取ってください。Chromiumでは、ゲームが全画面表示中にnavigator.keyboard.lock(['Escape'])を呼べます。その場合、ユーザーはEscを長押しして全画面表示を終えます。

キャンセルしたのにダイアログが閉じる

モーダルの<dialog>は、Escで自動的に閉じます。その前にcancelイベントが発生するので、これを止められます。

dialog.addEventListener('cancel', (event) => event.preventDefault());

Chromeで止められるのは1回だけです。間に何もクリックせずにもう一度Escを押すと、結局閉じます。意図してダイアログを開いたままにするなら、対応している環境ではclosedby="none"を設定します。また、cancelに頼らず、closeイベントでユーザーの作業を保存してください。

Escで2つのものが同時に閉じる

ダイアログの中でメニューが開いていると、両方が同じEscを受け取ります。いちばん内側のものだけを閉じてください。メニューでEscを処理したら、event.stopPropagation()を呼んでダイアログのコードが動かないようにします。さらにevent.preventDefault()を呼んで、ネイティブの<dialog>も閉じないようにします。ダイアログを閉じるのはハンドラーではなく、ブラウザの既定の動作だからです。

検索欄でEscを押すと中身が消える

Chromeなど一部のブラウザでは、Escで<input type="search">の中身が空になります。Escで検索ボックスを閉じたいなら、keydownでpreventDefault()を呼ぶか、中身を消して閉じる処理を一度に行ってください。

iPadのキーボードにEscキーがない

iPad用キーボードの中にはEscキーがないものがあり、スマホの画面のキーボードにはEscキーがありません。目に見える閉じるボタンも必ず用意してください。Escはショートカットであって、唯一の出口ではありません。

抜け出すためのEsc

キーボードで操作する人は、Escでメニュー、ポップアップ、ダイアログが閉じ、それを開いたボタンにフォーカスが戻ることを期待します。コードエディターやキーコード確認のキーの枠のように、すべてのキーを受け取るウィジェットでは、Escで解放してTabでまた先へ進めるようにします。そうすれば、キーボードの利用者が抜け出せなくなることはありません。