Base di conoscenzaCentro esami
ITItaliano
Scegli la lingua13

CKTIS / JavaScript

KeyboardEvent: valore del tasto e stato di composizione

Usa `key` per riconoscere il valore del tasto e `isComposing` per evitare di attivare una scorciatoia mentre un metodo di input sta componendo il testo.

Versione: ECMAScript 2024 and the current web platform; runtime support varies

Sintassi

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

// event is a KeyboardEvent instance.
// To construct a synthetic event:
new KeyboardEvent("keydown", { key: "Enter", isComposing: true })

event.key ed event.isComposing sono proprietà di sola lettura di un’istanza di KeyboardEvent. Fanno parte della piattaforma web, non di ECMAScript 2024; il loro supporto dipende dall’ambiente di esecuzione.

key è una stringa che tiene conto del layout della tastiera e dei modificatori, ad esempio "a" o "A" con Shift in un layout comune. I tasti speciali hanno valori predefiniti come "Enter" e "Escape". Se il browser non riconosce il tasto, restituisce "Unidentified". A differenza di code, key non descrive la posizione fisica del tasto. Per rilevare le modifiche al testo, ascolta l’evento input invece di ricostruire il testo dalle pressioni dei tasti.

isComposing è un booleano relativo al singolo evento. Per un evento generato dal browser, vale true se questo avviene dopo compositionstart e prima di compositionend. Un editor del metodo di input (IME) può usare Invio per accettare un suggerimento di testo. Nel gestore di keydown, non attivare quindi la scorciatoia quando isComposing è true.

All’inizio o alla fine della composizione, l’ordine degli eventi può far sì che isComposing sia false anche se l’IME gestisce il tasto. Prova le combinazioni di browser e IME che intendi supportare. Se necessario, valuta event.keyCode === 229 come ripiego deprecato per la compatibilità, non come garanzia universale.

Esempi

{
  const shouldRunShortcut = (event) =>
    event.key === "Enter" && !event.isComposing;

  for (const options of [
    { key: "Enter", isComposing: true },
    { key: "Enter", isComposing: false },
    { key: "Escape", isComposing: false },
  ]) {
    // Without KeyboardEvent, test the predicate with a plain object.
    const event = typeof KeyboardEvent === "function"
      ? new KeyboardEvent("keydown", options)
      : options;
    console.log(shouldRunShortcut(event) ? "run" : "skip");
  }
}

Risultato

skip
run
skip

Esegui l’esempio con Node.js o nella console di un browser compatibile. Se `KeyboardEvent` non è disponibile, l’esempio usa semplici oggetti con gli stessi valori di prova. Solo Invio fuori dalla composizione produce `run`. L’esempio non invia eventi né attiva un vero IME.

Lezioni correlate

  • JavaScript · Lezione 41 · Intermedio · Versione: 3

Fonti