/
closest.xml
181 lines (181 loc) · 7.17 KB
/
closest.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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
<?xml version="1.0"?>
<entries>
<entry type="method" name="closest" return="jQuery">
<title>.closest()</title>
<signature>
<added>1.3</added>
<argument name="selector" type="Selector">
<desc>A string containing a selector expression to match elements against.</desc>
</argument>
</signature>
<signature>
<added>1.4</added>
<argument name="selector" type="Selector">
<desc>A string containing a selector expression to match elements against.</desc>
</argument>
<argument name="context" optional="true" type="Element">
<desc>A DOM element within which a matching element may be found.</desc>
</argument>
</signature>
<signature>
<added>1.6</added>
<argument name="selection" type="jQuery">
<desc>A jQuery object to match elements against.</desc>
</argument>
</signature>
<signature>
<added>1.6</added>
<argument name="element" type="Element">
<desc>An element to match elements against.</desc>
</argument>
</signature>
<desc>For each element in the set, get the first element that matches the selector by testing the element itself and traversing up through its ancestors in the DOM tree.</desc>
<longdesc>
<p>Given a jQuery object that represents a set of DOM elements, the <code>.closest()</code> method searches through these elements and their ancestors in the DOM tree and constructs a new jQuery object from the matching elements. The <a href="/parents/"><code>.parents()</code></a> and <code>.closest()</code> methods are similar in that they both traverse up the DOM tree. The differences between the two, though subtle, are significant:</p>
<table>
<thead>
<tr>
<th>
<code>.closest()</code>
</th>
<th>
<a href="/parents/">
<code>.parents()</code>
</a>
</th>
</tr>
</thead>
<tbody>
<tr>
<td>Begins with the current element</td>
<td>Begins with the parent element</td>
</tr>
<tr>
<td>Travels up the DOM tree until it finds a match for the supplied selector</td>
<td>Travels up the DOM tree to the document's root element, adding each ancestor element to a temporary collection; it then filters that collection based on a selector if one is supplied </td>
</tr>
<tr>
<td>The returned jQuery object contains zero or one element for each element in the original set, in document order</td>
<td>The returned jQuery object contains zero or more elements for each element in the original set, in reverse document order</td>
</tr>
</tbody>
</table>
<pre><code>
<ul id="one" class="level-1">
<li class="item-i">I</li>
<li id="ii" class="item-ii">II
<ul class="level-2">
<li class="item-a">A</li>
<li class="item-b">B
<ul class="level-3">
<li class="item-1">1</li>
<li class="item-2">2</li>
<li class="item-3">3</li>
</ul>
</li>
<li class="item-c">C</li>
</ul>
</li>
<li class="item-iii">III</li>
</ul>
</code></pre>
<p>Suppose we perform a search for <code><ul></code> elements starting at item A:</p>
<pre><code>
$( "li.item-a" )
.closest( "ul" )
.css( "background-color", "red" );
</code></pre>
<p>This will change the color of the level-2 <code><ul></code>, since it is the first encountered when traveling up the DOM tree.</p>
<p>Suppose we search for an <code><li></code> element instead:</p>
<pre><code>
$( "li.item-a" )
.closest( "li" )
.css( "background-color", "red" );
</code></pre>
<p>This will change the color of list item A. The <code>.closest()</code> method begins its search <em>with the element itself</em> before progressing up the DOM tree, and stops when item A matches the selector.</p>
<p>We can pass in a DOM element as the context within which to search for the closest element.</p>
<pre><code>
var listItemII = document.getElementById( "ii" );
$( "li.item-a" )
.closest( "ul", listItemII )
.css( "background-color", "red" );
$( "li.item-a" )
.closest( "#one", listItemII )
.css( "background-color", "green" );
</code></pre>
<p>This will change the color of the level-2 <code><ul></code>, because it is both the first <code><ul></code> ancestor of list item A and a descendant of list item II. It will not change the color of the level-1 <code><ul></code>, however, because it is not a descendant of list item II.</p>
</longdesc>
<example>
<desc>Show how event delegation can be done with closest. The closest list element toggles a yellow background when it or its descendent is clicked.</desc>
<code><![CDATA[
$( document ).on( "click", function( event ) {
$( event.target ).closest( "li" ).toggleClass( "highlight" );
});
]]></code>
<css><![CDATA[
li {
margin: 3px;
padding: 3px;
background: #EEEEEE;
}
li.highlight {
background: yellow;
}
]]></css>
<html><![CDATA[
<ul>
<li><b>Click me!</b></li>
<li>You can also <b>Click me!</b></li>
</ul>
]]></html>
</example>
<example>
<desc>Pass a jQuery object to closest. The closest list element toggles a yellow background when it or its descendent is clicked.</desc>
<code><![CDATA[
var listElements = $( "li" ).css( "color", "blue" );
$( document ).on( "click", function( event ) {
$( event.target ).closest( listElements ).toggleClass( "highlight" );
});
]]></code>
<css><![CDATA[
li {
margin: 3px;
padding: 3px;
background: #EEEEEE;
}
li.highlight {
background: yellow;
}
]]></css>
<html><![CDATA[
<ul>
<li><b>Click me!</b></li>
<li>You can also <b>Click me!</b></li>
</ul>
]]></html>
</example>
<category slug="traversing/tree-traversal"/>
<category slug="version/1.3"/>
<category slug="version/1.4"/>
<category slug="version/1.6"/>
</entry>
<entry type="method" name="closest" return="Array" deprecated="1.7" removed="1.8">
<signature>
<added>1.4</added>
<argument name="selectors" type="Array">
<desc>An array or string containing a selector expression to match elements against (can also be a jQuery object).</desc>
</argument>
<argument name="context" optional="true" type="Element">
<desc>A DOM element within which a matching element may be found.</desc>
</argument>
</signature>
<desc>Get an array of all the elements and selectors matched against the current element up through the DOM tree.</desc>
<longdesc>
<div class="warning"><strong>This signature (only!) is deprecated as of jQuery 1.7 and <em>removed</em> in jQuery 1.8</strong>. It was primarily meant to be used internally or by plugin authors.</div>
</longdesc>
<category slug="traversing/tree-traversal"/>
<category slug="version/1.3"/>
<category slug="version/1.4"/>
<category slug="version/1.6"/>
</entry>
</entries>