-
Notifications
You must be signed in to change notification settings - Fork 264
/
Copy pathmouseout.xml
137 lines (132 loc) · 4.7 KB
/
mouseout.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
<?xml version="1.0"?>
<entries>
<desc>Bind an event handler to the "mouseout" event, or trigger that event on an element.</desc>
<entry type="method" name="on" return="jQuery">
<title>mouseout event</title>
<desc>Bind an event handler to the "mouseout" event.</desc>
<signature>
<added>1.7</added>
<argument name=""mouseout"" type="string">
<desc>The string <code>"mouseout"</code>.</desc>
</argument>
<argument name="eventData" type="Anything" optional="true">
<desc>An object containing data that will be passed to the event handler.</desc>
</argument>
<argument name="handler" type="Function">
<desc>A function to execute each time the event is triggered.</desc>
<argument name="eventObject" type="Event" />
</argument>
</signature>
<longdesc>
<div class="warning">
<p>This page describes the <code>mouseout</code> event. For the deprecated <code>.mouseout()</code> method, see <a href="/mouseout-shorthand/"><code>.mouseout()</code></a>.</p>
</div>
<p>The <code>mouseout</code> event is sent to an element when the mouse pointer leaves the element. Any HTML element can receive this event.</p>
<p>For example, consider the HTML:</p>
<pre><code>
<div id="outer">
Outer
<div id="inner">
Inner
</div>
</div>
<div id="other">
Trigger the handler
</div>
<div id="log"></div>
</code></pre>
<figure>
<img src="/resources/0042_05_07.png" alt=""/>
<figcaption>Figure 1 - Illustration of the rendered HTML</figcaption>
</figure>
<p>The event handler can be bound to any element:</p>
<pre><code>
$( "#outer" ).on( "mouseout", function() {
$( "#log" ).append( "Handler for `mouseout` called." );
} );
</code></pre>
<p>Now when the mouse pointer moves out of the <samp>Outer</samp> <code><div></code>, the message is appended to <code><div id="log"></code>. To trigger the event manually, use <code>.trigger( "mouseout" )</code>:</p>
<pre><code>
$( "#other" ).on( "click", function() {
$( "#outer" ).trigger( "mouseout" );
} );
</code></pre>
<p>After this code executes, clicks on <samp>Trigger the handler</samp> will also append the message.</p>
<p>This event type can cause many headaches due to event bubbling. For instance, when the mouse pointer moves out of the <samp>Inner</samp> element in this example, a <code>mouseout</code> event will be sent to that, then trickle up to <samp>Outer</samp>. This can trigger the bound <code>mouseout</code> handler at inopportune times. See the discussion for <code>.<a href="/mouseleave/">mouseleave</a>()</code> for a useful alternative.</p>
</longdesc>
<example>
<desc>Show the number of times mouseout and mouseleave events are triggered.
<code>mouseout</code> fires when the pointer moves out of the child element as well, while <code>mouseleave</code> fires only when the pointer moves out of the bound element.</desc>
<css><![CDATA[
div.out {
width: 40%;
height: 120px;
margin: 0 15px;
background-color: #d6edfc;
float: left;
}
div.in {
width: 60%;
height: 60%;
background-color: #fc0;
margin: 10px auto;
}
p {
line-height: 1em;
margin: 0;
padding: 0;
}
]]></css>
<code><![CDATA[
var i = 0;
$( "div.overout" )
.on( "mouseout", function() {
$( "p", this ).first().text( "mouse out" );
$( "p", this ).last().text( ++i );
} )
.on( "mouseover", function() {
$( "p", this ).first().text( "mouse over" );
} );
var n = 0;
$( "div.enterleave" )
.on( "mouseenter", function() {
$( "p", this ).first().text( "mouse enter" );
} )
.on( "mouseleave", function() {
$( "p", this ).first().text( "mouse leave" );
$( "p", this ).last().text( ++n );
} );
]]></code>
<html><![CDATA[
<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>
]]></html>
</example>
<category slug="events/mouse-events"/>
<category slug="version/1.0"/>
<category slug="version/1.7"/>
</entry>
<entry type="method" name="trigger" return="jQuery">
<title>mouseout event</title>
<desc>Trigger the "mouseout" event on an element.</desc>
<signature>
<added>1.0</added>
<argument name=""mouseout"" type="string">
<desc>The string <code>"mouseout"</code>.</desc>
</argument>
</signature>
<longdesc>
<p>See the description for <a href="#on1"><code>.on( "mouseout", ... )</code></a>.</p>
</longdesc>
<category slug="events/mouse-events"/>
<category slug="version/1.0"/>
</entry>
</entries>