MouseEvent.shiftKey

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

Syntax

var shiftKeyPressed = instanceOfMouseEvent.shiftKey

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 shiftKey property when you trigger a click event.

HTML

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

JavaScript

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

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

Result

Specifications

Specification Status Comment
Document Object Model (DOM) Level 3 Events Specification
The definition of 'MouseEvent.shiftKey' 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.shiftKey' in that specification.
Obsolete Initial definition.

Browser compatibility

BCD tables only load in the browser

See also