CKTIS / JavaScript
KeyboardEvent: valor de la tecla y estado de composición
Usa `key` para reconocer el valor de la tecla e `isComposing` para evitar que se active un atajo mientras un método de entrada está componiendo texto.
Versión: ECMAScript 2024 and the current web platform; runtime support varies
Sintaxis
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 y event.isComposing son propiedades de solo lectura de una instancia de KeyboardEvent. Pertenecen a la plataforma web, no a ECMAScript 2024, y su compatibilidad depende del entorno de ejecución.
key es una cadena que refleja la distribución del teclado y las teclas modificadoras: por ejemplo, "a" o "A" con Shift en una distribución habitual. Las teclas especiales tienen valores con nombre, como "Enter" y "Escape". Si el navegador no identifica la tecla, devuelve "Unidentified". A diferencia de code, key no describe la posición física de la tecla. Para observar cambios en el texto, escucha el evento input en lugar de reconstruir el texto a partir de las pulsaciones.
isComposing es un booleano propio de cada evento. En un evento generado por el navegador, vale true si ocurre después de compositionstart y antes de compositionend. Un editor de métodos de entrada (IME) puede usar Intro para aceptar una propuesta de texto. Por eso, en el controlador de keydown, no actives el atajo si isComposing vale true.
Al inicio o al final de la composición, el orden de los eventos puede hacer que isComposing valga false aunque el IME procese la tecla. Prueba las combinaciones de navegador e IME que necesites admitir. Si hace falta, considera event.keyCode === 229 como alternativa obsoleta de compatibilidad, no como garantía universal.
Ejemplos
{
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");
}
}Resultado
skip run skip
Ejecuta el ejemplo con Node.js o en la consola de un navegador compatible. Si `KeyboardEvent` no está disponible, el ejemplo usa objetos simples con los mismos valores de prueba. Solo Intro fuera de la composición muestra `run`. El ejemplo no despacha eventos ni activa un IME real.
Lecciones relacionadas
- JavaScript · Lección 41 · Intermedio · Versión: 3