WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / JavaScript

KeyboardEvent: Tastenwert und Status der Texteingabekomposition

Mit `key` erkennst du den Tastenwert. Mit `isComposing` vermeidest du, dass ein Tastenkürzel ausgelöst wird, während eine Eingabemethode noch Text zusammensetzt.

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

Syntax

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 und event.isComposing sind schreibgeschützte Eigenschaften einer KeyboardEvent-Instanz. Sie gehören zur Webplattform, nicht zu ECMAScript 2024. Ihre Unterstützung hängt von der Laufzeitumgebung ab.

key ist eine Zeichenfolge, die Tastaturlayout und Modifikatortasten berücksichtigt, etwa "a" oder mit Shift auf einem gängigen Layout "A". Sondertasten haben feste Namen wie "Enter" und "Escape". Kann der Browser die Taste nicht erkennen, meldet er "Unidentified". Anders als code beschreibt key nicht die physische Tastenposition. Verwende input, um Textänderungen zu beobachten, statt Text aus Tastenanschlägen zu rekonstruieren.

isComposing ist ein boolescher Wert pro Ereignis. Bei einem vom Browser erzeugten Ereignis ist er true, wenn es nach compositionstart und vor compositionend auftritt. Ein Eingabemethoden-Editor (IME) kann mit Enter einen Textvorschlag übernehmen. Löse deshalb im keydown-Handler kein Tastenkürzel aus, wenn isComposing den Wert true hat.

Zu Beginn oder Ende der Komposition kann die Ereignisreihenfolge dazu führen, dass isComposing trotz Verarbeitung der Taste durch den IME false ist. Teste die unterstützten Browser-IME-Kombinationen. Ziehe bei Bedarf event.keyCode === 229 als veraltete Kompatibilitätslösung in Betracht, nicht als allgemeine Garantie.

Beispiele

{
  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");
  }
}

Ergebnis

skip
run
skip

Führe das Beispiel mit Node.js oder in der Konsole eines unterstützten Browsers aus. Ist `KeyboardEvent` nicht verfügbar, verwendet das Beispiel einfache Objekte mit denselben Testwerten. Nur Enter außerhalb der Komposition gibt `run` aus. Das Beispiel löst keine Ereignisse aus und aktiviert keinen echten IME.

Zugehörige Lektionen

  • JavaScript · Lektion 41 · Mittlere Stufe · Version: 3

Quellen