CKTIS / JavaScript
KeyboardEvent : valeur de la touche et état de la composition
Utilisez `key` pour identifier la valeur de la touche et `isComposing` pour éviter de déclencher un raccourci pendant qu’une méthode de saisie compose du texte.
Version : ECMAScript 2024 and the current web platform; runtime support varies
Syntaxe
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 et event.isComposing sont deux propriétés en lecture seule d’une instance de KeyboardEvent. Elles relèvent de la plateforme web et non d’ECMAScript 2024. Leur prise en charge dépend de l’environnement d’exécution.
key est une chaîne qui tient compte de la disposition du clavier et des touches de modification, par exemple "a" ou "A" avec Shift sur une disposition courante. Les touches spéciales ont des valeurs nommées telles que "Enter" et "Escape". Si le navigateur ne reconnaît pas la touche, il renvoie "Unidentified". Contrairement à code, key ne décrit pas la position physique de la touche. Pour suivre les changements de texte, écoutez l’événement input plutôt que de reconstituer le texte à partir des frappes.
isComposing est un booléen propre à chaque événement. Pour un événement généré par le navigateur, il vaut true si celui-ci survient après compositionstart et avant compositionend. Un éditeur de méthode de saisie (IME) peut utiliser Entrée pour valider une proposition de texte. Dans le gestionnaire de keydown, ne déclenchez donc pas le raccourci si isComposing vaut true.
Au début ou à la fin de la composition, l’ordre des événements peut laisser isComposing à false même si l’IME traite la touche. Testez les combinaisons de navigateurs et d’IME que vous prenez en charge. Au besoin, envisagez event.keyCode === 229 comme solution de repli obsolète, sans garantie universelle.
Exemples
{
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");
}
}Résultat
skip run skip
Exécutez l’exemple avec Node.js ou dans la console d’un navigateur compatible. Si `KeyboardEvent` n’est pas disponible, l’exemple utilise de simples objets avec les mêmes valeurs de test. Seule la touche Entrée hors composition affiche `run`. L’exemple n’émet aucun événement et n’active pas de véritable IME.
Leçons associées
- JavaScript · Leçon 41 · Intermédiaire · Version : 3