index.md

title	KeyboardEvent: metaKey property
short-title	metaKey
slug	Web/API/KeyboardEvent/metaKey
page-type	web-api-instance-property
browser-compat	api.KeyboardEvent.metaKey

{{APIRef("UI Events")}}

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

{{ EmbedLiveSample('Examples', 400, 90) }}

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

• {{ domxref("KeyboardEvent") }}