MouseEvent: ctrlKey property
Baseline Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.
TheMouseEvent.ctrlKey read-only property is a boolean value that indicates whether thectrl key was pressed or not when a given mouse event occurs.
On Macintosh keyboards, this key is labeled thecontrol key. Also, note that on a Mac, a click combined with thecontrol key is intercepted by the operating system and used to open a context menu, soctrlKey is not detectable on click events.
Pinch-zooming using a trackpad also sends a simulatedwheel event withctrlKey set to true.
Value
A boolean value, wheretrue indicates that the key is pressed, andfalse indicates that the key isnot pressed.
Examples
This example logs thectrlKey property when you trigger amousemove event.
HTML
<p>The ctrl key was pressed while the cursor was moving: false</p>JavaScript
const log = document.querySelector("#log");window.addEventListener("mousemove", logKey);function logKey(e) { log.textContent = `The ctrl key was pressed while the cursor was moving: ${e.ctrlKey}`;}Result
Specifications
| Specification |
|---|
| UI Events # dom-mouseevent-ctrlkey |