KeyboardLayoutMap: get() method

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.

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 key that corresponds to the 'W' key on an English QWERTY keyboard.

js

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

Specifications

No specification found

No specification data found for api.KeyboardLayoutMap.get.
Check for problems with this page or contribute a missing spec_url to mdn/browser-compat-data. Also make sure the specification is included in w3c/browser-specs.

Browser compatibility

BCD tables only load in the browser