MouseEvent metaKey Property
THE WORLD'S LARGEST WEB DEVELOPER SITE

MouseEvent metaKey Property

❮ DOM Events ❮ MouseEvent

Example

Find out whether or not the "META" key was pressed when a mouse button is clicked:

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

Definition and Usage

The metaKey property returns a Boolean value that indicates whether or not the "META" key was pressed when a mouse event was triggered.

Not all keyboards have the meta key. It is common for Sun microsystem keyboards, and MIT and LISP machine keyboards. The meta key is either labeled "META" or marked with a solid diamond "◆" symbol.

On Mac keyboards, the META key is represented by the the "Command/Cmd" ("⌘") key.

Note: This property is read-only.


Browser Support

Property
metaKey Yes Yes Yes Yes Yes

Syntax

event.metaKey

Technical Details

Return Value: A Boolean, indicating whether the "META" key was pressed when the mouse event occured.

Possible values:

  • true - The meta key was pressed
  • false - The meta key was not pressed
DOM Version: DOM Level 2 Events

Related Pages

HTML DOM reference: MouseEvent altKey Property

HTML DOM reference: MouseEvent ctrlKey Property

HTML DOM reference: MouseEvent shiftKey Property


❮ DOM Events ❮ MouseEvent