KeyboardLayoutMap: get() method

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

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

The get() method of the KeyboardLayoutMap interface returns the element with the given key.

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

The method is otherwise the same as Map.prototype.get().

Syntax

js
get(key)

Parameters

key

The key of the item to return from the map.

Return value

The value of the specified key.

Examples

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

js
navigator.keyboard.getLayoutMap().then((keyboardLayoutMap) => {
  const upKey = keyboardLayoutMap.get("KeyW");
  window.alert(`Press ${upKey} to move up.`);
});

Specifications

Specification
ECMAScript Language Specification
# sec-map.prototype.get

Browser compatibility

BCD tables only load in the browser

See also