Base de conhecimentoCentro de Exames
PT · PTPortuguês (Portugal)
Escolher idioma13

CKTIS / JavaScript

KeyboardEvent: valor da tecla e estado do Shift

`key` indica o valor da tecla e `shiftKey` indica se o Shift estava ativo no momento do evento. Usa ambas as propriedades para distinguir Enter de Shift+Enter.

Versão: ECMAScript 2024 and the current web platform; runtime support varies

Sintaxe

event.key      // string, read-only
 event.shiftKey // boolean, read-only

key e shiftKey são duas propriedades só de leitura de uma instância de KeyboardEvent. event.key é uma cadeia de caracteres: contém a representação textual de uma tecla imprimível ou um valor predefinido, como "Enter", para uma tecla especial. Nos eventos gerados pelo navegador, a disposição do teclado e os modificadores ativos influenciam key. Se o que importa é a posição física da tecla, usa antes event.code.

event.shiftKey é um valor booleano: true se o Shift estava ativo no momento do evento, ou false caso contrário. Descreve esse evento, não o estado atual do teclado. Não confundas event.key === "Shift", que identifica a própria tecla Shift, com event.shiftKey, que pode ser true para outra tecla.

Num manipulador de keydown, event.key === "Enter" && event.shiftKey deteta Enter com o Shift ativo. A condição não exclui outros modificadores. KeyboardEvent é uma API da Web, não faz parte do ECMAScript 2024; a disponibilidade depende do ambiente de execução.

Exemplos

{
  const eventInits = [
    { key: "Enter" },
    { key: "Enter", shiftKey: true },
  ];

  // Without KeyboardEvent, use plain objects to model just these two properties.
  const events = eventInits.map((init) =>
    typeof KeyboardEvent === "function"
      ? new KeyboardEvent("keydown", init)
      : { key: init.key, shiftKey: init.shiftKey ?? false }
  );

  for (const event of events) {
    const isShiftEnter = event.key === "Enter" && event.shiftKey;
    console.log(`${event.key} | shiftKey=${event.shiftKey} | match=${isShiftEnter}`);
  }
}

Resultado

Enter | shiftKey=false | match=false
Enter | shiftKey=true | match=true

Executa o código na consola de programador do navegador ou como script no Node.js. No navegador, o código cria dois eventos sintéticos `KeyboardEvent` sem os despachar. Se o construtor não estiver disponível, usa objetos simples que reproduzem apenas `key` e `shiftKey`. Em ambos os objetos, `key` tem o valor `"Enter"`. No primeiro, `shiftKey` é omitido nas opções e assume o valor `false`; no segundo, é definido como `true`. Só o segundo objeto satisfaz a condição.

Lições relacionadas

  • JavaScript · Lição 40 · Intermédio · Versão: 3

Fontes