Code de la touche Échap

Échap envoie event.key « Escape », event.code « Escape » et keyCode 27.

Toutes les valeurs d’un coup d’œil

Valeurs pour Échap
Toucheevent.codeevent.keykeyCodeevent.location
ÉchapEscapeEscape270 (Standard)

keyCode tel que Chrome et Edge l’envoient sous Windows. La colonne Mac (Chrome et Safari sur Mac) et la colonne Firefox n’affichent que les nombres qui diffèrent. Certaines touches diffèrent aussi selon le système, comme le dit le texte plus bas. event.which est toujours le même nombre que keyCode. event.key correspond à une disposition américaine sans Maj.

Appuyez dessus ici

Cliquez ici, puis appuyez sur Échap

Vous n’utilisez que le clavier ? Appuyez sur Échap, puis sur Tab, pour quitter la zone de touche.

Code pour réagir à Échap

Recommandé : reconnaître event.key
document.addEventListener('keydown', (event) => {
  if (event.key === 'Escape') {
    // Votre code ici
  }
});
Reconnaître la place de la touche : event.code
document.addEventListener('keydown', (event) => {
  if (event.code === 'Escape') {
    // Votre code ici
  }
});
Ancien code qui utilise encore keyCode (obsolète)
document.addEventListener('keydown', (event) => {
  if (event.keyCode === 27) {
    // Votre code ici
  }
});

Quelle valeur utiliser

Vérifiez event.key === 'Escape'. Il n’y a qu’une touche Échap, et elle envoie la même valeur sur toutes les dispositions : event.key et event.code disent donc la même chose ici. key se lit mieux.

keyCode 27 arrive encore dans tous les navigateurs, mais il est obsolète.

Les très vieux navigateurs envoyaient "Esc" à la place : Internet Explorer et Firefox 36 et les versions plus anciennes. N’acceptez les deux que si vous les gérez encore.

Ce qui pose problème

Échap quitte le plein écran et mon gestionnaire ne peut pas l’arrêter

En plein écran (et en verrouillage du pointeur), Échap appartient au navigateur. Elle quitte toujours, et preventDefault() n’y change rien ; votre gestionnaire peut même ne pas voir cet appui sur Échap. Écoutez fullscreenchange pour savoir quand c’est arrivé. Dans Chromium, un jeu peut appeler navigator.keyboard.lock(['Escape']) en plein écran ; l’utilisateur maintient alors Échap pour quitter.

La boîte de dialogue se ferme alors que je l’ai annulée

Un <dialog> modal se ferme tout seul avec Échap. Il déclenche d’abord un événement cancel, que vous pouvez arrêter :

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

Chrome ne vous laisse l’arrêter qu’une fois : appuyez de nouveau sur Échap sans rien cliquer entre-temps, et elle se ferme quand même. Pour garder une boîte de dialogue ouverte volontairement, définissez closedby="none" là où c’est pris en charge, et enregistrez le travail de l’utilisateur dans l’événement close plutôt que de compter sur cancel.

Échap ferme deux choses à la fois

Quand un menu est ouvert dans une boîte de dialogue, les deux entendent le même appui sur Échap. Ne fermez que l’élément le plus interne : gérez Échap sur le menu, puis appelez event.stopPropagation() pour que le code de votre boîte de dialogue ne s’exécute pas, et event.preventDefault() pour qu’un <dialog> natif ne se ferme pas aussi : sa fermeture est l’action par défaut du navigateur, pas celle d’un gestionnaire.

Échap dans un champ de recherche l’efface

Dans Chrome et quelques autres navigateurs, Échap vide un <input type="search">. Si Échap doit plutôt fermer votre zone de recherche, appelez preventDefault() dans keydown, ou effacez et fermez en une seule étape.

Il n’y a pas de touche Échap sur un clavier d’iPad

Certains claviers d’iPad n’ont pas de touche Échap, et les téléphones n’en ont jamais. Ajoutez toujours aussi un bouton de fermeture visible. Échap est un raccourci, pas la seule sortie.

Échap comme sortie

Les utilisateurs du clavier s’attendent à ce qu’Échap ferme les menus, les fenêtres contextuelles et les boîtes de dialogue, et rende le focus au bouton qui les a ouverts. Si un composant capte toutes les touches, comme un éditeur de code ou la zone de l’outil keycode, laissez Échap le libérer, pour que Tab fonctionne de nouveau. Cela évite aux utilisateurs du clavier de rester bloqués.