Capturer des touches avec l'API Keyboard Lock

Offrez une expérience immersive en plein écran pour divers cas d'utilisation, y compris les sites Web interactifs, les jeux, et le streaming de bureau à distance ou d'applications.

Thomas Steiner

De plus en plus d'utilisateurs passent la plupart de leur temps dans le navigateur. Les sites Web riches et interactifs, les jeux, le streaming de bureau à distance et le streaming d'applications s'efforcent de fournir une expérience immersive en plein écran. Pour ce faire, les sites ont besoin d'accéder à des touches spéciales et à des raccourcis clavier lorsqu'ils sont en mode plein écran, afin de pouvoir les utiliser pour la navigation, les menus ou les jeux. Voici quelques exemples de touches qui peuvent être requises : Échap, Alt+Tabulation, Cmd+` et Ctrl+N.

Par défaut, ces clés ne sont pas disponibles pour l'application Web, car elles sont capturées par le navigateur ou le système d'exploitation sous-jacent. L'API Keyboard Lock permet aux sites Web d'utiliser toutes les touches disponibles autorisées par l'OS hôte (voir Compatibilité du navigateur).

Ubuntu Linux diffusé en streaming dans un onglet de navigateur dans macOS Chrome (pas encore en mode plein écran).
Problème : un bureau à distance Ubuntu Linux en streaming ne s'exécute pas en mode plein écran et sans verrouillage du clavier actif. Les touches système sont donc toujours capturées par le système d'exploitation hôte macOS et l'expérience n'est pas encore immersive.

Utiliser l'API Keyboard Lock

L'interface Keyboard de l'API Keyboard fournit des fonctions qui activent ou désactivent la capture des frappes au clavier physique, et qui permettent d'obtenir des informations sur la disposition du clavier de l'utilisateur.

Conditions préalables

Il existe deux types de plein écran dans les navigateurs modernes : celui initié par JavaScript via l'API Fullscreen et celui initié par l'utilisateur via un raccourci clavier. L'API Keyboard Lock n'est disponible que lorsque le plein écran initié par JavaScript est actif. Voici un exemple de plein écran initié par JavaScript :

await document.documentElement.requestFullscreen();

Détection de caractéristiques

Vous pouvez utiliser le modèle suivant pour vérifier si l'API Keyboard Lock est compatible :

if ('keyboard' in navigator && 'lock' in navigator.keyboard) {
  // Supported!
}

Verrouiller le clavier

La méthode lock() de l'interface Keyboard renvoie une promesse après avoir activé la capture des frappes pour une partie ou l'ensemble des touches du clavier physique. Cette méthode ne peut capturer que les clés auxquelles le système d'exploitation sous-jacent a accordé l'accès. La méthode lock() utilise un tableau d'un ou plusieurs codes de clé à verrouiller. Si aucun code clé n'est fourni, toutes les clés sont verrouillées. Une liste des valeurs de code de touche valides est disponible dans la spécification UI Events KeyboardEvent code Values.

Capturer toutes les clés

L'exemple suivant capture toutes les frappes au clavier.

navigator.keyboard.lock();

Capturer des clés spécifiques

L'exemple suivant capture les touches W, A, S et D. Ces touches sont capturées quels que soient les modificateurs utilisés avec la pression sur la touche. En supposant une disposition QWERTY américaine, l'enregistrement de "KeyW" garantit que W, Maj + W, Ctrl + W, Ctrl + Maj + W et toutes les autres combinaisons de touches de modification avec W sont envoyées à l'application. Il en va de même pour "KeyA", "KeyS" et "KeyD".

await navigator.keyboard.lock([
  "KeyW",
  "KeyA",
  "KeyS",
  "KeyD",
]);

Vous pouvez répondre aux frappes de touches capturées à l'aide d'événements de clavier. Par exemple, ce code utilise l'événement onkeydown :

document.addEventListener('keydown', (event) => {
  if ((event.code === 'KeyA') && !(event.ctrlKey || event.metaKey)) {
    // Do something when the 'A' key was pressed, but only
    // when not in combination with the command or control key.
  }
});

Déverrouiller le clavier

La méthode unlock() déverrouille toutes les clés capturées par la méthode lock() et renvoie les résultats de manière synchrone.

navigator.keyboard.unlock();

Lorsqu'un document est fermé, le navigateur appelle toujours implicitement unlock().

Démo

Vous pouvez tester l'API Keyboard Lock en exécutant cette démonstration. N'oubliez pas de consulter le code source. Cliquez sur le bouton "Passer en mode plein écran" ci-dessous pour lancer la démo dans une nouvelle fenêtre et passer en mode plein écran.

Points à noter concernant la sécurité

L'un des problèmes de cette API est qu'elle pourrait être utilisée pour récupérer toutes les clés et (en combinaison avec l'API Fullscreen et l'API PointerLock) empêcher l'utilisateur de quitter la page Web. Pour éviter cela, la spécification exige que le navigateur permette à l'utilisateur de quitter le verrouillage du clavier, même si toutes les touches sont demandées par l'API. Dans Chrome, cette échappatoire consiste à appuyer de manière prolongée (deux secondes) sur la touche Échap pour quitter le verrouillage du clavier.

Remerciements

Cet article a été examiné par Joe Medley et Kayce Basques. La spécification Keyboard Lock a été rédigée par Gary Kacmarcik et Jamie Walch. Image principale de Ken Suarez sur Unsplash.