MouseEvent metaKey Property

Example

Was the "META" key pressed when the mouse button was clicked:

if (event.metaKey) {
  let text = "The META key was pressed!"
} else {
  let text = "The META key was NOT pressed!");
}
Try it Yourself »

Description

The metaKey property returns true if the META key is pressed when a mouse event is triggered, otherwise it returns false.

The metaKey property is read-only.

Note

Not all keyboards have a META key.

On Windows it is the Window ⊞ key. On Mac machines it is the Cmd ⌘ key.

See Also:

The altKey Property

The ctrlKey Property

The shiftKey Property

The Mouse Event Object


Syntax

event.metaKey

Technical Details

Return Value: A Boolean.
true if the META key was pressed when a mouse event occured, otherwise false.
DOM Version: DOM Level 2 Events

Browser Support

event.metaKey is a DOM Level 2 (2001) feature.

It is fully supported in all browsers:

Chrome Edge Firefox Safari Opera IE
Yes Yes Yes Yes Yes 9-11


Copyright 1999-2023 by Refsnes Data. All Rights Reserved.