Keyboard

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

The Keyboard interface of the 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() 
Returns a Promise that resolves with an instance of KeyboardLayoutMap which is a map-like object with fucntions for retrieving the strings associated with specific physical keys.
Keyboard.lock() 
Returns a Promise after enabling the capture of keypresses for any or all of the keys on the physical keyboard.
Keyboard.unlock() 
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

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidEdge MobileFirefox for AndroidOpera for AndroidSafari on iOSSamsung Internet
Basic support
Experimental
Chrome Full support 68Edge No support NoFirefox No support NoIE No support NoOpera Full support 55Safari No support NoWebView Android No support NoChrome Android No support NoEdge Mobile No support NoFirefox Android No support NoOpera Android No support NoSafari iOS No support NoSamsung Internet Android No support No
getLayoutMap
Experimental
Chrome Full support 69Edge No support NoFirefox No support NoIE No support NoOpera Full support 56Safari No support NoWebView Android No support NoChrome Android No support NoEdge Mobile No support NoFirefox Android No support NoOpera Android No support NoSafari iOS No support NoSamsung Internet Android No support No
lock
Experimental
Chrome Full support 68Edge No support NoFirefox No support NoIE No support NoOpera Full support 55Safari No support NoWebView Android No support NoChrome Android No support NoEdge Mobile No support NoFirefox Android No support NoOpera Android No support NoSafari iOS No support NoSamsung Internet Android No support No
unlock
Experimental
Chrome Full support 68Edge No support NoFirefox No support NoIE No support NoOpera Full support 55Safari No support NoWebView Android No support NoChrome Android No support NoEdge Mobile No support NoFirefox Android No support NoOpera Android No support NoSafari iOS No support NoSamsung Internet Android No support No

Legend

Full support  
Full support
No support  
No support
Experimental. Expect behavior to change in the future.
Experimental. Expect behavior to change in the future.

Document Tags and Contributors

Contributors to this page: wbamberg, jpmedley
Last updated by: wbamberg,