forked from jquery/api.jquery.com
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathadd.xml
158 lines (157 loc) · 6.71 KB
/
add.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
<?xml version="1.0"?>
<entry type="method" name="add" return="jQuery">
<title>.add()</title>
<signature>
<added>1.0</added>
<argument name="selector" type="Selector">
<desc>A string representing a selector expression to find additional elements to add to the set of matched elements.</desc>
</argument>
</signature>
<signature>
<added>1.0</added>
<argument name="elements" type="Element">
<desc>One or more elements to add to the set of matched elements.</desc>
</argument>
</signature>
<signature>
<added>1.0</added>
<argument name="html" type="htmlString">
<desc>An HTML fragment to add to the set of matched elements.</desc>
</argument>
</signature>
<signature>
<added>1.1</added>
<argument name="selection" type="jQuery">
<desc>An existing jQuery object to add to the set of matched elements.</desc>
</argument>
</signature>
<signature>
<added>1.4</added>
<argument name="selector" type="Selector">
<desc>A string representing a selector expression to find additional elements to add to the set of matched elements.</desc>
</argument>
<argument name="context" type="Element">
<desc>The point in the document at which the selector should begin matching; similar to the context argument of the <code>$(selector, context)</code> method.</desc>
</argument>
</signature>
<desc>Create a new jQuery object with elements added to the set of matched elements.</desc>
<longdesc>
<p>Given a jQuery object that represents a set of DOM elements, the <code>.add()</code> method constructs a new jQuery object from the union of those elements and the ones passed into the method. The argument to <code>.add()</code> can be pretty much anything that <code>$()</code> accepts, including a jQuery selector expression, references to DOM elements, or an HTML snippet.</p>
<p>Do not assume that this method appends the elements to the existing collection in the order they are passed to the <code>.add()</code> method. When all elements are members of the same document, the resulting collection from <code>.add()</code> will be sorted in document order; that is, in order of each element's appearance in the document. If the collection consists of elements from different documents or ones not in any document, the sort order is undefined. To create a jQuery object with elements in a well-defined order and without sorting overhead, use the <code>$(array_of_DOM_elements)</code> signature.</p>
<p>The updated set of elements can be used in a following (chained) method, or assigned to a variable for later use. For example:</p>
<pre><code>
$( "p" ).add( "div" ).addClass( "widget" );
var pdiv = $( "p" ).add( "div" );
</code></pre>
<p>The following will <em>not</em> save the added elements, because the <code>.add()</code> method creates a new set and leaves the original set in pdiv unchanged:</p>
<pre><code>
var pdiv = $( "p" );
pdiv.add( "div" ); // WRONG, pdiv will not change
</code></pre>
<p>Consider a page with a simple list and a paragraph following it:</p>
<pre><code>
<ul>
<li>list item 1</li>
<li>list item 2</li>
<li>list item 3</li>
</ul>
<p>a paragraph</p>
</code></pre>
<p>We can select the list items and then the paragraph by using either a selector or a reference to the DOM element itself as the <code>.add()</code> method's argument:</p>
<pre><code>
$( "li" ).add( "p" ).css( "background-color", "red" );
</code></pre>
<p>Or:</p>
<pre><code>
$( "li" ).add( document.getElementsByTagName( "p" )[ 0 ] )
.css( "background-color", "red" );
</code></pre>
<p>The result of this call is a red background behind all four elements.
Using an HTML snippet as the <code>.add()</code> method's argument (as in the third version), we can create additional elements on the fly and add those elements to the matched set of elements. Let's say, for example, that we want to alter the background of the list items along with a newly created paragraph:</p>
<pre><code>
$( "li" ).add( "<p id='new'>new paragraph</p>" )
.css( "background-color", "red" );
</code></pre>
<p>Although the new paragraph has been created and its background color changed, it still does not appear on the page. To place it on the page, we could add one of the insertion methods to the chain.</p>
<p>As of jQuery 1.4 the results from .add() will always be returned in document order (rather than a simple concatenation).</p>
<p><strong>Note:</strong> To reverse the <code>.add()</code> you can use <a href="/not/"><code>.not( elements | selector )</code></a> to remove elements from the jQuery results, or <a href="/end/"><code>.end()</code></a> to return to the selection before you added.</p>
</longdesc>
<example>
<desc>Finds all divs and makes a border. Then adds all paragraphs to the jQuery object to set their backgrounds yellow.</desc>
<code><![CDATA[
$( "div" ).css( "border", "2px solid red" )
.add( "p" )
.css( "background", "yellow" );
]]></code>
<css><![CDATA[
div {
width: 60px;
height: 60px;
margin: 10px;
float: left;
}
p {
clear: left;
font-weight: bold;
font-size: 16px;
color: blue;
margin: 0 10px;
padding: 2px;
}
]]></css>
<html><![CDATA[
<div></div>
<div></div>
<div></div>
<div></div>
<div></div>
<div></div>
<p>Added this... (notice no border)</p>
]]></html>
</example>
<example>
<desc>Adds more elements, matched by the given expression, to the set of matched elements.</desc>
<code><![CDATA[
$( "p" ).add( "span" ).css( "background", "yellow" );
]]></code>
<html><![CDATA[
<p>Hello</p>
<span>Hello Again</span>
]]></html>
</example>
<example>
<desc>Adds more elements, created on the fly, to the set of matched elements.</desc>
<code><![CDATA[
$( "p" ).clone().add( "<span>Again</span>" ).appendTo( document.body );
]]></code>
<html><![CDATA[
<p>Hello</p>
]]></html>
</example>
<example>
<desc>Adds one or more Elements to the set of matched elements.</desc>
<code><![CDATA[
$( "p" ).add( document.getElementById( "a" ) ).css( "background", "yellow" );
]]></code>
<html><![CDATA[
<p>Hello</p>
<span id="a">Hello Again</span>
]]></html>
</example>
<example>
<desc>Demonstrates how to add (or push) elements to an existing collection</desc>
<code><![CDATA[
var collection = $( "p" );
// Capture the new collection
collection = collection.add( document.getElementById( "a" ) );
collection.css( "background", "yellow" );
]]></code>
<html><![CDATA[
<p>Hello</p>
<span id="a">Hello Again</span>
]]></html>
</example>
<category slug="traversing/miscellaneous-traversal"/>
<category slug="version/1.0"/>
<category slug="version/1.4"/>
</entry>