Description: Bind an event handler to the "mouseout" JavaScript event, or trigger that event on an element.
.mouseout( handler(eventObject) )
version added: 1.0
handler(eventObject)
A function to execute each time the event is triggered.
.mouseout( )
version added: 1.0
.mouseout( [ eventData ], handler(eventObject) )
version added: 1.4.3
eventData
A map of data that will be passed to the event handler.
handler(eventObject)
A function to execute each time the event is triggered.
This method is a shortcut for .bind('mouseout', handler) in the first variation, and .trigger('mouseout') in the second.
The mouseout event is sent to an element when the mouse pointer leaves the element. Any HTML element can receive this event.
For example, consider the HTML:
<div id="target"> Move here </div> <div id="other"> Trigger the handler </div> <div id="log"></div>
Move here
Trigger the handler
The event handler can be bound to any element:
$('#outer').mouseout(function() {
$('#log').append('Handler for .mouseout() called.');
});
Now when the mouse pointer moves out of the Outer <div>, the message is appended to <div id="log">. We can also trigger the event when another element is clicked:
$('#other').click(function() {
$('#outer').mouseout();
});
After this code executes, clicks on Trigger the handler will also append the message.
This event type can cause many headaches due to event bubbling. For instance, when the mouse pointer moves out of the Inner element in this example, a mouseout event will be sent to that, then trickle up to Outer. This can trigger the bound mouseout handler at inopportune times. See the discussion for .mouseleave() for a useful alternative.
Examples
Show texts when mouseover and mouseout event triggering. Mouseout fires when the pointer moves into or out from child element, while mouseleave doesn`t.
var i = 0;
$("div.overout").mouseout(function(){
$("p:first",this).text("mouse out");
$("p:last",this).text(++i);
}).mouseover(function(){
$("p:first",this).text("mouse over");
});
var n = 0;
$("div.enterleave").bind("mouseenter",function(){
$("p:first",this).text("mouse enter");
}).bind("mouseleave",function(){
$("p:first",this).text("mouse leave");
$("p:last",this).text(++n);
});
Example - Full code:
<!DOCTYPE html> <html> <head> <script src="http://code.jquery.com/jquery-latest.js"></script> <script type="text/javascript" language="javascript"> $(document).ready(function(){ var i = 0; $("div.overout").mouseout(function(){ $("p:first",this).text("mouse out"); $("p:last",this).text(++i); }).mouseover(function(){ $("p:first",this).text("mouse over"); }); var n = 0; $("div.enterleave").bind("mouseenter",function(){ $("p:first",this).text("mouse enter"); }).bind("mouseleave",function(){ $("p:first",this).text("mouse leave"); $("p:last",this).text(++n); }); }); </script> <style> div.out { width:40%; height:120px; margin:0 15px; background-color:#D6EDFC; float:left; } div.in { width:60%; height:60%; background-color:#FFCC00; margin:10px auto; } p { line-height:1em; margin:0; padding:0; } </style> </head> <body> <div class="out overout"><p>move your mouse</p> <div class="in overout"><p>move your mouse</p> <p>0</p></div><p>0</p></div> <div class="out enterleave"><p>move your mouse</p> <div class="in enterleave"> <p>move your mouse</p> <p>0</p></div><p>0</p></div> </body> </html>
Was this information helpful?
