KeyboardLayoutMap: keys() 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 keys() method of the KeyboardLayoutMap interface returns a new Iterator object that contains the keys for each index in the KeyboardLayoutMap object.

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

Syntax

js
keys()

Return value

A new Iterator object.

Examples

The following example iterates every keyboard code on an English QWERTY keyboard.

js
navigator.keyboard.getLayoutMap().then((keyboardLayoutMap) => {
  for (const code of keyboardLayoutMap.keys()) {
    console.log(`${code} keyboard code`);
  }
});

Specifications

Specification
ECMAScript® 2025 Language Specification
# sec-map.prototype.keys

Browser compatibility

BCD tables only load in the browser

See also