dom / latest / mouseevent / shiftkey.html /

MouseEvent.shiftKey

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

Value

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

Examples

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

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
shiftKey
1
12
1.5
9
≤12.1
1
≤37
18
4
≤12.1
1
1.0

See also

© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/shiftKey