MouseEvent

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⁩.

* Some parts of this feature may have varying levels of support.

TheMouseEvent interface represents events that occur due to the user interacting with a pointing device (such as a mouse).Common events using this interface includeclick,dblclick,mouseup,mousedown.

MouseEvent derives fromUIEvent, which in turn derives fromEvent.Though theMouseEvent.initMouseEvent() method is kept for backward compatibility, creating of aMouseEvent object should be done using theMouseEvent() constructor.

Several more specific events are based onMouseEvent, includingWheelEvent,DragEvent, andPointerEvent.

Constructor

MouseEvent(): Creates aMouseEvent object.

Static properties

MouseEvent.WEBKIT_FORCE_AT_MOUSE_DOWNNon-standardRead only: Minimum force necessary for a normal click.
MouseEvent.WEBKIT_FORCE_AT_FORCE_MOUSE_DOWNNon-standardRead only: Minimum force necessary for a force click.

Instance properties

This interface also inherits properties of its parents,UIEvent andEvent.

MouseEvent.altKeyRead only: Returnstrue if thealt key was down when the mouse event was fired.
MouseEvent.buttonRead only: The button number that was pressed or released (if applicable) when the mouse event was fired.
MouseEvent.buttonsRead only: The buttons being pressed (if any) when the mouse event was fired.
MouseEvent.clientXRead only: The X coordinate of the mouse pointer inviewport coordinates.
MouseEvent.clientYRead only: The Y coordinate of the mouse pointer inviewport coordinates.
MouseEvent.ctrlKeyRead only: Returnstrue if thecontrol key was down when the mouse event was fired.
MouseEvent.layerXNon-standardRead only: Returns the horizontal coordinate of the event relative to the current layer.
MouseEvent.layerYNon-standardRead only: Returns the vertical coordinate of the event relative to the current layer.
MouseEvent.metaKeyRead only: Returnstrue if themeta key was down when the mouse event was fired.
MouseEvent.movementXRead only: The X coordinate of the mouse pointer relative to the position of the lastmousemove event.
MouseEvent.movementYRead only: The Y coordinate of the mouse pointer relative to the position of the lastmousemove event.
MouseEvent.offsetXRead only: The X coordinate of the mouse pointer relative to the position of the padding edge of the target node.
MouseEvent.offsetYRead only: The Y coordinate of the mouse pointer relative to the position of the padding edge of the target node.
MouseEvent.pageXRead only: The X coordinate of the mouse pointer relative to the whole document.
MouseEvent.pageYRead only: The Y coordinate of the mouse pointer relative to the whole document.
MouseEvent.relatedTargetRead only: The secondary target for the event, if there is one.
MouseEvent.screenXRead only: The X coordinate of the mouse pointer inscreen coordinates.
MouseEvent.screenYRead only: The Y coordinate of the mouse pointer inscreen coordinates.
MouseEvent.shiftKeyRead only: Returnstrue if theshift key was down when the mouse event was fired.
MouseEvent.mozInputSourceNon-standardRead only: The type of device that generated the event (one of theMOZ_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 only: The amount of pressure applied when clicking.
MouseEvent.xRead only: Alias forMouseEvent.clientX.
MouseEvent.yRead only: Alias forMouseEvent.clientY.

Instance methods

This interface also inherits methods of its parents,UIEvent andEvent.

MouseEvent.getModifierState(): Returns the current state of the specified modifier key. SeeKeyboardEvent.getModifierState() for details.
MouseEvent.initMouseEvent()Deprecated: Initializes the value of aMouseEvent created. If the event has already been dispatched, this method does nothing.

Example

This example demonstrates simulating a click (programmatically generating a click event) on a checkbox using DOM methods.Event state (canceled or not) is then determined with the return value of methodEventTarget.dispatchEvent().

HTML

html

<p>  <label><input type="checkbox" /> Checked</label></p><p>  <button>Click me to send a MouseEvent to the checkbox</button></p>

JavaScript

function simulateClick() {  // Get the element to send a click event  const cb = document.getElementById("checkbox");  // Create a synthetic click MouseEvent  let evt = new MouseEvent("click", {    bubbles: true,    cancelable: true,    view: window,  });  // Send the event to the checkbox element  cb.dispatchEvent(evt);}document.getElementById("button").addEventListener("click", simulateClick);