Back to Content

Element: mouseover event

files/en-us/web/api/element/mouseover_event/index.md

latest6.4 KB
Original Source

{{APIRef("UI Events")}}

The mouseover event is fired at an {{domxref("Element")}} when a pointing device (such as a mouse or trackpad) is used to move the cursor onto the element or one of its child elements.

If the target element has child elements, mouseout and mouseover events fire as the mouse moves over the boundaries of these elements too, not just the target element itself. Usually, mouseenter and mouseleave events' behavior is more sensible, because they are not affected by moving into child elements.

Syntax

Use the event name in methods like {{domxref("EventTarget.addEventListener", "addEventListener()")}}, or set an event handler property.

js-nolint
addEventListener("mouseover", (event) => { })

onmouseover = (event) => { }

Event type

A {{domxref("MouseEvent")}}. Inherits from {{domxref("UIEvent")}} and {{domxref("Event")}}.

{{InheritanceDiagram("MouseEvent")}}

Event properties

This interface also inherits properties of its parents, {{domxref("UIEvent")}} and {{domxref("Event")}}.

  • {{domxref("MouseEvent.altKey")}} {{ReadOnlyInline}}
    • : Returns true if the <kbd>alt</kbd> key was down when the mouse event was fired.
  • {{domxref("MouseEvent.button")}} {{ReadOnlyInline}}
    • : The button number that was pressed (if applicable) when the mouse event was fired.
  • {{domxref("MouseEvent.buttons")}} {{ReadOnlyInline}}
    • : The buttons being pressed (if any) when the mouse event was fired.
  • {{domxref("MouseEvent.clientX")}} {{ReadOnlyInline}}
  • {{domxref("MouseEvent.clientY")}} {{ReadOnlyInline}}
  • {{domxref("MouseEvent.ctrlKey")}} {{ReadOnlyInline}}
    • : Returns true if the <kbd>control</kbd> key was down when the mouse event was fired.
  • {{domxref("MouseEvent.layerX")}} {{Non-standard_inline}} {{ReadOnlyInline}}
    • : Returns the horizontal coordinate of the event relative to the current layer.
  • {{domxref("MouseEvent.layerY")}} {{Non-standard_inline}} {{ReadOnlyInline}}
    • : Returns the vertical coordinate of the event relative to the current layer.
  • {{domxref("MouseEvent.metaKey")}} {{ReadOnlyInline}}
    • : Returns true if the <kbd>meta</kbd> key was down when the mouse event was fired.
  • {{domxref("MouseEvent.movementX")}} {{ReadOnlyInline}}
    • : The X coordinate of the mouse pointer relative to the position of the last {{domxref("Element/mousemove_event", "mousemove")}} event.
  • {{domxref("MouseEvent.movementY")}} {{ReadOnlyInline}}
    • : The Y coordinate of the mouse pointer relative to the position of the last {{domxref("Element/mousemove_event", "mousemove")}} event.
  • {{domxref("MouseEvent.offsetX")}} {{ReadOnlyInline}}
    • : The X coordinate of the mouse pointer relative to the position of the padding edge of the target node.
  • {{domxref("MouseEvent.offsetY")}} {{ReadOnlyInline}}
    • : The Y coordinate of the mouse pointer relative to the position of the padding edge of the target node.
  • {{domxref("MouseEvent.pageX")}} {{ReadOnlyInline}}
    • : The X coordinate of the mouse pointer relative to the whole document.
  • {{domxref("MouseEvent.pageY")}} {{ReadOnlyInline}}
    • : The Y coordinate of the mouse pointer relative to the whole document.
  • {{domxref("MouseEvent.relatedTarget")}} {{ReadOnlyInline}}
    • : The secondary target for the event, if there is one.
  • {{domxref("MouseEvent.screenX")}} {{ReadOnlyInline}}
  • {{domxref("MouseEvent.screenY")}} {{ReadOnlyInline}}
  • {{domxref("MouseEvent.shiftKey")}} {{ReadOnlyInline}}
    • : Returns true if the <kbd>shift</kbd> key was down when the mouse event was fired.
  • {{domxref("MouseEvent.mozInputSource")}} {{non-standard_inline()}} {{ReadOnlyInline}}
    • : The 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).
  • {{domxref("MouseEvent.webkitForce")}} {{non-standard_inline()}} {{ReadOnlyInline}}
    • : The amount of pressure applied when clicking.
  • {{domxref("MouseEvent.x")}} {{ReadOnlyInline}}
    • : Alias for {{domxref("MouseEvent.clientX")}}.
  • {{domxref("MouseEvent.y")}} {{ReadOnlyInline}}
    • : Alias for {{domxref("MouseEvent.clientY")}}.

Examples

The following example illustrates the difference between mouseover and {{domxref("Element/mouseenter_event", "mouseenter")}} events.

HTML

html
<ul id="test">
  <li>item 1</li>
  <li>item 2</li>
  <li>item 3</li>
</ul>

JavaScript

js
const test = document.getElementById("test");

// This handler will be executed only once when the cursor
// moves over the unordered list
test.addEventListener("mouseenter", (event) => {
  // highlight the mouseenter target
  event.target.style.color = "purple";

  // reset the color after a short delay
  setTimeout(() => {
    event.target.style.color = "";
  }, 500);
});

// This handler will be executed every time the cursor
// is moved over a different list item
test.addEventListener("mouseover", (event) => {
  // highlight the mouseover target
  event.target.style.color = "orange";

  // reset the color after a short delay
  setTimeout(() => {
    event.target.style.color = "";
  }, 500);
});

Result

{{EmbedLiveSample('Examples')}}

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

  • Learn: Introduction to events
  • {{domxref("Element/mousedown_event", "mousedown")}}
  • {{domxref("Element/mouseup_event", "mouseup")}}
  • {{domxref("Element/mousemove_event", "mousemove")}}
  • {{domxref("Element/click_event", "click")}}
  • {{domxref("Element/dblclick_event", "dblclick")}}
  • {{domxref("Element/mouseout_event", "mouseout")}}
  • {{domxref("Element/mouseenter_event", "mouseenter")}}
  • {{domxref("Element/mouseleave_event", "mouseleave")}}
  • {{domxref("Element/contextmenu_event", "contextmenu")}}
  • {{domxref("Element/pointerover_event", "pointerover")}}