W3cubDocs

/Web APIs

KeyboardEvent: metaKey property

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since ⁨July 2015⁩.

The KeyboardEvent.metaKey read-only property returning a boolean value that indicates if the Meta key was pressed (true) or not (false) when the event occurred. Some operating systems may intercept the key so it is never detected.

Note: On Macintosh keyboards, this is the ⌘ Command key.

Note: Before Firefox 118, the ⊞ Windows key was handled as an "OS" key rather than the "Meta" key. KeyboardEvent.metaKey was false when the ⊞ Windows key was pressed.

Value

A boolean value.

Examples

<button>Click me with the meta key</button>

<p id="output"></p>

document.querySelector("button").addEventListener("click", (e) => {
  document.querySelector("#output").textContent =
    `metaKey pressed? ${e.metaKey}`;
});

Result

Specifications

Specification
UI Events> # dom-keyboardevent-metakey>

Browser compatibility