KennisbankExamencentrum
NL · NLNederlands (Nederland)
Taal kiezen13

CKTIS / JavaScript

KeyboardEvent: toetswaarde en compositiestatus

Gebruik `key` om de toetswaarde te herkennen en `isComposing` om te voorkomen dat een sneltoets afgaat terwijl een invoermethode nog tekst samenstelt.

Versie: 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 en event.isComposing zijn alleen-lezen eigenschappen van een KeyboardEvent-instantie. Ze behoren tot het webplatform, niet tot ECMAScript 2024. De ondersteuning hangt af van de uitvoeringsomgeving.

key is een tekenreeks die rekening houdt met de toetsenbordindeling en modificatietoetsen, bijvoorbeeld "a" of "A" met Shift op een gangbare indeling. Speciale toetsen hebben vaste waarden, zoals "Enter" en "Escape". Als de browser de toets niet herkent, geeft hij "Unidentified" terug. Anders dan code beschrijft key niet de fysieke toetspositie. Luister naar de input-gebeurtenis om tekstwijzigingen te volgen, in plaats van tekst uit toetsaanslagen te reconstrueren.

isComposing is een booleaanse waarde per gebeurtenis. Bij een door de browser gegenereerde gebeurtenis is die waarde true als de gebeurtenis na compositionstart en vóór compositionend plaatsvindt. Een invoermethode-editor (IME) kan Enter gebruiken om een tekstsuggestie te accepteren. Sla daarom de sneltoets over in de keydown-handler als isComposing true is.

Aan het begin of einde van de compositie kan de volgorde van de gebeurtenissen ervoor zorgen dat isComposing false is, ook als de IME de toets verwerkt. Test de browser-IME-combinaties die je ondersteunt. Overweeg indien nodig event.keyCode === 229 als verouderde compatibiliteitsoplossing, niet als universele garantie.

Voorbeelden

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

Resultaat

skip
run
skip

Voer het voorbeeld uit met Node.js of in de console van een browser die de API ondersteunt. Als `KeyboardEvent` niet beschikbaar is, gebruikt het voorbeeld gewone objecten met dezelfde testwaarden. Alleen Enter buiten de compositie geeft `run`. Het voorbeeld verzendt geen gebeurtenissen en activeert geen echte IME.

Gerelateerde lessen

  • JavaScript · Les 41 · Gemiddeld · Versie: 3

Bronnen