KeyboardEvent

Konstruktor

KeyboardEvent()

Erstellt ein neues KeyboardEvent-Objekt.

Konstanten

Das KeyboardEvent-Interface definiert die folgenden Konstanten.

Tastaturpositionen

Die folgenden Konstanten identifizieren, aus welchem Teil der Tastatur das Tastenereignis stammt. Sie werden als KeyboardEvent.DOM_KEY_LOCATION_STANDARD usw. aufgerufen.

Instanz-Eigenschaften

Dieses Interface erbt auch Eigenschaften seiner Eltern, UIEvent und Event.

KeyboardEvent.altKey Schreibgeschützt

Gibt einen Booleschen Wert zurück, der true ist, wenn die Alt (Option oder ⌥ auf macOS) Taste aktiv war, als das Tastenereignis generiert wurde.

KeyboardEvent.code Schreibgeschützt

Gibt einen String mit dem Codewert der physikalischen Taste zurück, die durch das Ereignis dargestellt wird.

Warnung: Dies ignoriert das Tastaturlayout des Benutzers, so dass, wenn der Benutzer die Taste an der Position "Y" in einem QWERTY-Tastaturlayout drückt (nahe der Mitte der Zeile über der Home-Reihe), dies immer "KeyY" zurückgibt, selbst wenn der Benutzer eine QWERTZ-Tastatur hat (was bedeuten würde, dass der Benutzer ein "Z" erwartet und alle anderen Eigenschaften ein "Z" anzeigen würden) oder ein Dvorak-Tastaturlayout (wobei der Benutzer ein "F" erwartet). Wenn Sie dem Benutzer die korrekten Tastenanschläge anzeigen möchten, können Sie Keyboard.getLayoutMap() verwenden.

KeyboardEvent.ctrlKey Schreibgeschützt

Gibt einen Booleschen Wert zurück, der true ist, wenn die Ctrl Taste aktiv war, als das Tastenereignis generiert wurde.

KeyboardEvent.isComposing Schreibgeschützt

Gibt einen Booleschen Wert zurück, der true ist, wenn das Ereignis zwischen compositionstart und compositionend ausgelöst wird.

KeyboardEvent.key Schreibgeschützt

Gibt einen String zurück, der den Tastenwert der durch das Ereignis dargestellten Taste repräsentiert.

KeyboardEvent.location Schreibgeschützt

Gibt eine Zahl zurück, die die Position der Taste auf der Tastatur oder einem anderen Eingabegerät darstellt. Eine Liste der Konstanten, die die Positionen identifizieren, ist oben unter Tastaturpositionen aufgeführt.

KeyboardEvent.metaKey Schreibgeschützt

Gibt einen Booleschen Wert zurück, der true ist, wenn die Meta Taste (auf Mac-Tastaturen, die ⌘ Command Taste; auf Windows-Tastaturen, die Windows-Taste (⊞)) aktiv war, als das Tastenereignis generiert wurde.

KeyboardEvent.repeat Schreibgeschützt

Gibt einen Booleschen Wert zurück, der true ist, wenn die Taste so gehalten wird, dass sie automatisch wiederholt wird.

KeyboardEvent.shiftKey Schreibgeschützt

Gibt einen Booleschen Wert zurück, der true ist, wenn die Shift Taste aktiv war, als das Tastenereignis generiert wurde.

Veraltete Eigenschaften

KeyboardEvent.charCode Veraltet Schreibgeschützt

Gibt eine Zahl zurück, die die Unicode-Referenznummer der Taste darstellt; diese Eigenschaft wird nur vom keypress Ereignis verwendet. Für Tasten, deren char-Eigenschaft mehrere Zeichen enthält, ist dies der Unicode-Wert des ersten Zeichens in dieser Eigenschaft. In Firefox 26 gibt dies Codes für druckbare Zeichen zurück.

KeyboardEvent.keyCode Veraltet Schreibgeschützt

Gibt eine Zahl zurück, die einen system- und implementierungsabhängigen numerischen Code darstellt, der den unmodifizierten Wert der gedrückten Taste identifiziert.

KeyboardEvent.keyIdentifier Nicht standardisiert Veraltet Schreibgeschützt

Diese Eigenschaft ist nicht standardisiert und wurde zugunsten von KeyboardEvent.key veraltet. Sie war Teil einer alten Version von DOM Level 3 Events.

Instanz-Methoden

Dieses Interface erbt auch Methoden seiner Eltern, UIEvent und Event.

KeyboardEvent.getModifierState()

Gibt einen Booleschen Wert zurück, der anzeigt, ob eine Modifikator-Taste wie Alt, Shift, Ctrl oder Meta gedrückt war, als das Ereignis erstellt wurde.

Veraltete Methoden

KeyboardEvent.initKeyboardEvent() Veraltet

Initialisiert ein KeyboardEvent-Objekt. Dies ist jetzt veraltet. Stattdessen sollte der KeyboardEvent() Konstruktor verwendet werden.

Ereignisse

Die folgenden Ereignisse basieren auf dem KeyboardEvent Typ. In der untenstehenden Liste verlinkt jedes Ereignis auf die Dokumentation für den Element-Handler für das Ereignis, der generell für alle Empfänger gilt, einschließlich Element, Document und Window.

keydown

Eine Taste wurde gedrückt.

keyup

Eine Taste wurde losgelassen.

Veraltete Ereignisse

keypress Veraltet

Eine Taste, die normalerweise einen Zeichenwert erzeugt, wurde gedrückt. Dieses Ereignis war stark geräteabhängig und ist veraltet. Sie sollten es nicht verwenden.

Nutzungshinweise

Es gibt drei Arten von Tastaturereignissen: keydown, keypress und keyup. Für die meisten Tasten löst Gecko eine Sequenz von Tastenereignissen wie folgt aus:

1. Wenn die Taste zunächst gedrückt wird, wird das keydown-Ereignis gesendet.
2. Wenn die Taste keine Modifikatortaste ist, wird das keypress-Ereignis gesendet.
3. Wenn der Benutzer die Taste loslässt, wird das keyup-Ereignis gesendet.

Sonderfälle

Einige Tasten schalten den Status einer Anzeigelampe um; dazu gehören Tasten wie Feststelltaste, NumLock und ScrollLock. Unter Windows und Linux lösen diese Tasten nur die keydown- und keyup-Ereignisse aus.

Ein Modellbeschränkung des macOS-Ereignismodells führt jedoch dazu, dass Caps Lock nur das keydown-Ereignis auslöst. NumLock wurde auf einigen älteren Laptop-Modellen (Modelle von 2007 und älter) unterstützt, aber seitdem hat macOS den NumLock auch auf externen Tastaturen nicht mehr unterstützt. Auf älteren MacBooks mit einer NumLock-Taste generiert diese Taste keine Tastenereignisse. Gecko unterstützt die ScrollLock-Taste, wenn eine externe Tastatur mit einer F14-Taste angeschlossen ist. In bestimmten älteren Versionen von Firefox generierte diese Taste ein keypress-Ereignis; dieses inkonsistente Verhalten war Firefox-Bug 602812.

Umgang mit automatischer Wiederholung

Wenn eine Taste gedrückt gehalten wird, beginnt sie, sich automatisch zu wiederholen. Dies führt zu einer Sequenz von Ereignissen wie der folgenden:

1. keydown
2. keypress
3. keydown
4. keypress
5. <<wiederholt sich, bis der Benutzer die Taste loslässt>>
6. keyup

Dies ist, was die DOM Level 3-Spezifikation besagt, dass passieren sollte. Es gibt jedoch einige Vorbehalte, wie unten beschrieben.

Automatische Wiederholung in einigen GTK-Umgebungen wie Ubuntu 9.4

In einigen auf GTK basierenden Umgebungen löst die automatische Wiederholung während der automatischen Wiederholung ein natives Tastenausgabeereignis automatisch aus, und es gibt keine Möglichkeit für Gecko, den Unterschied zwischen einer wiederholt gedrückten Tastenfolge und einer automatischen Wiederholung zu erkennen. Auf diesen Plattformen generiert dann eine automatisch wiederholte Taste die folgende Ereignissequenz:

1. keydown
2. keypress
3. keyup
4. keydown
5. keypress
6. keyup
7. <<wiederholt sich, bis der Benutzer die Taste loslässt>>
8. keyup

In diesen Umgebungen gibt es leider keine Möglichkeit, dass Webinhalte den Unterschied zwischen automatisch wiederholten Tasten und Tasten, die nur wiederholt gedrückt werden, erkennen können.

Beispiel

document.addEventListener("keydown", (event) => {
  const keyName = event.key;

  if (keyName === "Control") {
    // do not alert when only Control key is pressed.
    return;
  }

  if (event.ctrlKey) {
    // Even though event.key is not 'Control' (e.g., 'a' is pressed),
    // event.ctrlKey may be true if Ctrl key is pressed at the same time.
    alert(`Combination of ctrlKey + ${keyName}`);
  } else {
    alert(`Key pressed ${keyName}`);
  }
});

document.addEventListener("keyup", (event) => {
  const keyName = event.key;

  // As the user releases the Ctrl key, the key is no longer active,
  // so event.ctrlKey is false.
  if (keyName === "Control") {
    alert("Control key was released");
  }
});

Spezifikationen

Die Spezifikation des KeyboardEvent-Interfaces durchlief zahlreiche Entwurfsversionen, zuerst unter DOM Events Level 2, wo es fallen gelassen wurde, da kein Konsens erzielt wurde, dann unter DOM Events Level 3. Dies führte zur Implementierung nicht standardisierter Initialisierungsmethoden, der frühen DOM Events Level 2-Version KeyboardEvent.initKeyEvent() durch Gecko-Browser und der frühen DOM Events Level 3-Version KeyboardEvent.initKeyboardEvent() durch andere. Beide wurden durch die moderne Verwendung eines Konstruktors ersetzt: KeyboardEvent().

Browser-Kompatibilität

Kompatibilitätsnotizen

• Ab Firefox 65 wird das keypress-Ereignis nicht mehr für nicht druckbare Tasten ausgelöst (Firefox-Bug 968056), außer für die Enter-Taste und die Shift + Enter- und Ctrl + Enter-Tastenkombinationen (diese wurden aus Gründen der Browser-Kompatibilität beibehalten).

Siehe auch

• KeyboardEvent.code.
• KeyboardEvent.key.
• KeyboardEvent.getModifierState()