-
Notifications
You must be signed in to change notification settings - Fork 264
/
Copy pathmouseover.xml
137 lines (132 loc) · 4.59 KB
/
mouseover.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 "mouseover" event, or trigger that event on an element.</desc>
<entry type="method" name="on" return="jQuery">
<title>mouseover event</title>
<desc>Bind an event handler to the "mouseover" event.</desc>
<signature>
<added>1.7</added>
<argument name=""mouseover"" type="string">
<desc>The string <code>"mouseover"</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>mouseover</code> event. For the deprecated <code>.mouseover()</code> method, see <a href="/mouseover-shorthand/"><code>.mouseover()</code></a>.</p>
</div>
<p>The <code>mouseover</code> event is sent to an element when the mouse pointer enters 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_06.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( "mouseover", function() {
$( "#log" ).append( "<div>Handler for `mouseover` called.</div>" );
} );
</code></pre>
<p>Now when the mouse pointer moves over the <samp>Outer</samp> <code><div></code>, the message is appended to <code><div id="log"></code>. We can also trigger the event when another element is clicked:</p>
<pre><code>
$( "#other" ).on( "click", function() {
$( "#outer" ).trigger( "mouseover" );
} );
</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 over the <samp>Inner</samp> element in this example, a <code>mouseover</code> event will be sent to that, then trickle up to <samp>Outer</samp>. This can trigger our bound <code>mouseover</code> handler at inopportune times. See the discussion for <code>.mouseenter()</code> for a useful alternative.</p>
</longdesc>
<example>
<desc>Show the number of times mouseover and mouseenter events are triggered.
<code>mouseover</code> fires when the pointer moves into the child element as well, while <code>mouseenter</code> fires only when the pointer moves into 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( "mouseover", function() {
i += 1;
$( this ).find( "span" ).text( "mouse over x " + i );
} )
.on( "mouseout", function() {
$( this ).find( "span" ).text( "mouse out " );
} );
var n = 0;
$( "div.enterleave" )
.on( "mouseenter", function() {
n += 1;
$( this ).find( "span" ).text( "mouse enter x " + n );
} )
.on( "mouseleave", function() {
$( this ).find( "span" ).text( "mouse leave" );
} );
]]></code>
<html><![CDATA[
<div class="out overout">
<span>move your mouse</span>
<div class="in">
</div>
</div>
<div class="out enterleave">
<span>move your mouse</span>
<div class="in">
</div>
</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>mouseover event</title>
<desc>Trigger the "mouseover" event on an element.</desc>
<signature>
<added>1.0</added>
<argument name=""mouseover"" type="string">
<desc>The string <code>"mouseover"</code>.</desc>
</argument>
</signature>
<longdesc>
<p>See the description for <a href="#on1"><code>.on( "mouseover", ... )</code></a>.</p>
</longdesc>
<category slug="events/mouse-events"/>
<category slug="version/1.0"/>
</entry>
</entries>