Código da tecla Escape
O Esc envia event.key "Escape", event.code "Escape" e keyCode 27.
Todos os valores de relance
| Tecla | event.code | event.key | keyCode | event.location |
|---|---|---|---|---|
| Esc | Escape | Escape | 27 | 0 (Padrão) |
keyCode como o Chrome e o Edge enviam no Windows. A coluna do Mac (Chrome e Safari no Mac) e a do Firefox mostram só os números diferentes; algumas teclas também mudam conforme o sistema, como diz o texto abaixo. event.which é sempre o mesmo número do keyCode. event.key vale para um layout dos EUA sem Shift.
Pressione aqui
Clique aqui e pressione Escape
Está usando só o teclado? Pressione Esc e depois Tab para sair da caixa de teclas.
Código para reagir a Escape
document.addEventListener('keydown', (event) => {
if (event.key === 'Escape') {
// Seu código aqui
}
});document.addEventListener('keydown', (event) => {
if (event.code === 'Escape') {
// Seu código aqui
}
});document.addEventListener('keydown', (event) => {
if (event.keyCode === 27) {
// Seu código aqui
}
});Qual valor usar
Confira event.key === 'Escape'. Há só uma tecla Esc, e ela envia o mesmo valor em todos os layouts, então event.key e event.code dizem a mesma coisa aqui. O key é mais fácil de ler.
O keyCode 27 ainda chega em todos os navegadores, mas é obsoleto.
Navegadores muito antigos enviavam "Esc": o Internet Explorer e o Firefox 36 e anteriores. Aceite os dois só se você ainda dá suporte a eles.
O que costuma dar errado
O Esc sai da tela cheia e meu tratador não consegue impedir
Na tela cheia (e no bloqueio do ponteiro), o Esc é do navegador. Ele sempre sai, e preventDefault() não ajuda: seu tratador pode nem ver esse Esc. Escute fullscreenchange para saber quando aconteceu. No Chromium, um jogo pode chamar navigator.keyboard.lock(['Escape']) na tela cheia. Então a pessoa segura o Esc para sair.
O diálogo fecha mesmo que eu tenha cancelado
Um <dialog> modal fecha com o Esc por conta própria. Primeiro ele dispara um evento cancel, que você pode impedir:
dialog.addEventListener('cancel', (event) => event.preventDefault());
O Chrome deixa você impedir só uma vez: aperte o Esc de novo sem clicar em nada no meio e ele fecha de qualquer jeito. Para manter um diálogo aberto de propósito, defina closedby="none" onde for aceito e salve o trabalho da pessoa no evento close, em vez de depender do cancel.
O Esc fecha duas coisas ao mesmo tempo
Quando um menu está aberto dentro de um diálogo, os dois ouvem o mesmo Esc. Feche só o que está mais por dentro: trate o Esc no menu, depois chame event.stopPropagation() para o código do diálogo não rodar, e event.preventDefault() para um <dialog> nativo não fechar também: fechar é a ação padrão do navegador, não de um tratador.
O Esc num campo de busca o limpa
No Chrome e em alguns outros navegadores, o Esc esvazia um <input type="search">. Se o Esc deve fechar a sua caixa de busca, chame preventDefault() no keydown, ou limpe e feche num só passo.
Não há tecla Esc num teclado de iPad
Alguns teclados de iPad não têm a tecla Esc, e os celulares nunca têm. Dê sempre também um botão de fechar visível. O Esc é um atalho, não a única saída.
O Esc como saída
Quem usa o teclado espera que o Esc feche menus, pop-ups e diálogos e devolva o foco ao botão que os abriu. Se um componente captura todas as teclas, como um editor de código ou o campo da nossa ferramenta de keycode, deixe o Esc liberá-lo, para o Tab voltar a funcionar. Assim, quem usa o teclado não fica preso.