Keyboard

Experimental

This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The Keyboard interface of the Keyboard API provides functions that retrieve keyboard layout maps and toggle capturing of key presses from the physical keyboard.

A list of valid code values is found in the UI Events KeyboardEvent code Values spec.

Properties

None.

Methods

Keyboard.getLayoutMap()  This is an experimental API that should not be used in production code.
Returns a Promise that resolves with an instance of KeyboardLayoutMap which is a map-like object with functions for retrieving the strings associated with specific physical keys.
Keyboard.lock()  This is an experimental API that should not be used in production code.
Returns a Promise after enabling the capture of keypresses for any or all of the keys on the physical keyboard.
Keyboard.unlock()  This is an experimental API that should not be used in production code.
Unlocks all keys captured by the lock() method and returns synchronously.

Example

The following example demonstrates how to get the location- or layout-specific string associated with the key that corresponds to the 'W' key on an English QWERTY keyboard.

if (navigator.keyboard) {
  var keyboard = navigator.keyboard;
  keyboard.getLayoutMap()
  .then(keyboardLayoutMap => {
    var upKey = keyboardLayoutMap.get('KeyW');
    window.alert('Press ' + upKey + ' to move up.');
  });
} else {
  // Do something else.
}

Specifications

Specification Status Comment
Keyboard Map
The definition of 'Keyboard' in that specification.
Editor's Draft Initial definition.
Keyboard Lock
The definition of 'Keyboard' in that specification.
Editor's Draft Adds lock() and unlock().

Browser compatibility

BCD tables only load in the browser