Element: dblclick event
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.
Thedblclick event fires when a pointing device button (such as a mouse's primary button) is double-clicked; that is, when it's rapidly clicked twice on a single element within a very short span of time.
dblclick fires after twoclick events (and by extension, after two pairs ofmousedown andmouseup events).
In this article
Syntax
Use the event name in methods likeaddEventListener(), or set an event handler property.
addEventListener("dblclick", (event) => { })ondblclick = (event) => { }Event type
AMouseEvent. Inherits fromUIEvent andEvent.
Event properties
This interface also inherits properties of its parents,UIEvent andEvent.
MouseEvent.altKeyRead onlyReturns
trueif thealt key was down when the mouse event was fired.MouseEvent.buttonRead onlyThe button number that was pressed (if applicable) when the mouse event was fired.
MouseEvent.buttonsRead onlyThe buttons being pressed (if any) when the mouse event was fired.
MouseEvent.clientXRead onlyThe X coordinate of the mouse pointer inviewport coordinates.
MouseEvent.clientYRead onlyThe Y coordinate of the mouse pointer inviewport coordinates.
MouseEvent.ctrlKeyRead onlyReturns
trueif thecontrol key was down when the mouse event was fired.MouseEvent.layerXNon-standardRead onlyReturns the horizontal coordinate of the event relative to the current layer.
MouseEvent.layerYNon-standardRead onlyReturns the vertical coordinate of the event relative to the current layer.
MouseEvent.metaKeyRead onlyReturns
trueif themeta key was down when the mouse event was fired.MouseEvent.movementXRead onlyThe X coordinate of the mouse pointer relative to the position of the last
mousemoveevent.MouseEvent.movementYRead onlyThe Y coordinate of the mouse pointer relative to the position of the last
mousemoveevent.MouseEvent.offsetXRead onlyThe X coordinate of the mouse pointer relative to the position of the padding edge of the target node.
MouseEvent.offsetYRead onlyThe Y coordinate of the mouse pointer relative to the position of the padding edge of the target node.
MouseEvent.pageXRead onlyThe X coordinate of the mouse pointer relative to the whole document.
MouseEvent.pageYRead onlyThe Y coordinate of the mouse pointer relative to the whole document.
MouseEvent.relatedTargetRead onlyThe secondary target for the event, if there is one.
MouseEvent.screenXRead onlyThe X coordinate of the mouse pointer inscreen coordinates.
MouseEvent.screenYRead onlyThe Y coordinate of the mouse pointer inscreen coordinates.
MouseEvent.shiftKeyRead onlyReturns
trueif theshift key was down when the mouse event was fired.MouseEvent.mozInputSourceNon-standardRead onlyThe type of device that generated the event (one of the
MOZ_SOURCE_*constants).This lets you, for example, determine whether a mouse event was generated by an actual mouse or by a touch event (which might affect the degree of accuracy with which you interpret the coordinates associated with the event).MouseEvent.webkitForceNon-standardRead onlyThe amount of pressure applied when clicking.
MouseEvent.xRead onlyAlias for
MouseEvent.clientX.MouseEvent.yRead onlyAlias for
MouseEvent.clientY.
Examples
This example toggles the size of a card when you double click on it.
JavaScript
const card = document.querySelector("aside");card.addEventListener("dblclick", (e) => { card.classList.toggle("large");});HTML
<aside> <h3>My Card</h3> <p>Double click to resize this object.</p></aside>CSS
aside { background: #ffee99; border-radius: 1em; display: inline-block; padding: 1em; transform: scale(0.9); transform-origin: 0 0; transition: transform 0.6s; user-select: none;}.large { transform: scale(1.3);}Result
Specifications
| Specification |
|---|
| UI Events> # event-type-dblclick> |
| HTML> # handler-ondblclick> |