MouseEvent.metaKey

The MouseEvent.metaKey read-only property is a Boolean that indicates whether the meta key was pressed or not when a given mouse event occurs.

Be aware that many operating systems bind special functionality to the meta key, so this property may be false even when the key is actually pressed. On Windows, for example, this key may open the Start menu.

Note: On Macintosh keyboards, this key is the command key (⌘). On Windows keyboards, this key is the Windows key (⊞).

Syntax

var metaKeyPressed = instanceOfMouseEvent.metaKey

Return value

A Boolean, where true indicates that the key is pressed, and false indicates that the key is not pressed.

Example

This example logs the metaKey property when you trigger a click event.

HTML

<p>Click anywhere to test the <code>metaKey</code> property.</p>
<p id="log"></p>

JavaScript

let log = document.querySelector('#log');
document.addEventListener('click', logKey);

function logKey(e) {
  log.textContent = `The meta key is pressed: ${e.metaKey}`;
}

Result

Specifications

Specification Status Comment
Document Object Model (DOM) Level 3 Events Specification
The definition of 'MouseEvent.metaKey' in that specification.
Obsolete No change from Document Object Model (DOM) Level 2 Events Specification.
Document Object Model (DOM) Level 2 Events Specification
The definition of 'MouseEvent.metaKey' in that specification.
Obsolete Initial definition.

Browser compatibility

BCD tables only load in the browser

See also