Back to Content

KeyboardLayoutMap: has() method

files/en-us/web/api/keyboardlayoutmap/has/index.md

latest1.0 KB
Original Source

{{APIRef("Keyboard API")}}{{SeeCompatTable}}

The has() method of the {{domxref('KeyboardLayoutMap')}} interface returns a boolean indicating whether the object has an element with the specified key.

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

The method is otherwise the same as {{jsxref("Map.prototype.has()")}}.

Syntax

js-nolint
has(key)

Parameters

  • key
    • : The key of an element to search for in the map.

Return value

A {{jsxref('Boolean')}} indicating whether the specified key was found.

Examples

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

js
navigator.keyboard.getLayoutMap().then((keyboardLayoutMap) => {
  console.log(keyboardLayoutMap.has("KeyW"));
});

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

  • {{jsxref("Map.prototype.has()")}}