Element: mouseout 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.
Themouseout event is fired at anElement when a pointing device (usually a mouse) is used to move the cursor so that it is no longer contained within the element or one of its children.
mouseout is also delivered to an element if the cursor enters a child element, because the child element obscures the visible area of the element.
If the target element has child elements,mouseout andmouseover events fire as the mouse moves over the boundaries of these elements too, not just the target element itself. Usually,mouseenter andmouseleave events' behavior is more sensible, because they are not affected by moving into child elements.
In this article
Syntax
Use the event name in methods likeaddEventListener(), or set an event handler property.
addEventListener("mouseout", (event) => { })onmouseout = (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
The following examples show the use of themouseout event.
mouseout and mouseleave
The following example illustrates the difference betweenmouseout andmouseleave events. Themouseleave event is added to the<ul> to color the list purple whenever the mouse exits the<ul>.mouseout is added to the list to color the targeted element orange when the mouse exits it.
When you try this out, you'll find thatmouseout is delivered to the individual list items, whilemouseleave goes to the overall list, courtesy of the hierarchy of the items and the fact that list items obscure the underlying<ul>.
HTML
<ul> <li>item 1</li> <li>item 2</li> <li>item 3</li></ul>JavaScript
const test = document.getElementById("test");// Briefly make the list purple when the mouse moves off the// <ul> elementtest.addEventListener("mouseleave", (event) => { // highlight the mouseleave target event.target.style.color = "purple"; // reset the color after a short delay setTimeout(() => { event.target.style.color = ""; }, 1000);});// Briefly make an <li> orange when the mouse moves off of ittest.addEventListener("mouseout", (event) => { // highlight the mouseout target event.target.style.color = "orange"; // reset the color after a short delay setTimeout(() => { event.target.style.color = ""; }, 500);});Result
Specifications
| Specification |
|---|
| UI Events> # event-type-mouseout> |
| HTML> # handler-onmouseout> |