.wrap( wrappingElement ) Returns: jQuery
Description: Wrap an HTML structure around each element in the set of matched elements.
-
version added: 1.0.wrap( wrappingElement )
-
wrappingElementA selector, element, HTML string, or jQuery object specifying the structure to wrap around the matched elements.
-
-
version added: 1.4.wrap( function(index) )
-
function(index)Type: Function()A callback function returning the HTML content or jQuery object to wrap around the matched elements. Receives the index position of the element in the set as an argument. Within the function,
thisrefers to the current element in the set.
-
The .wrap() function can take any string or object that could be passed to the $() factory function to specify a DOM structure. This structure may be nested several levels deep, but should contain only one inmost element. A copy of this structure will be wrapped around each of the elements in the set of matched elements. This method returns the original set of elements for chaining purposes.
Consider the following HTML:
|
1
2
3
4
|
|
Using .wrap(), we can insert an HTML structure around the inner <div> elements like so:
|
1
|
|
The new <div> element is created on the fly and added to the DOM. The result is a new <div> wrapped around each matched element:
|
1
2
3
4
5
6
7
8
|
|
The second version of this method allows us to instead specify a callback function. This callback function will be called once for every matched element; it should return a DOM element, jQuery object, or HTML snippet in which to wrap the corresponding element. For example:
|
1
2
3
|
|
This will cause each <div> to have a class corresponding to the text it wraps:
|
1
2
3
4
5
6
7
8
|
|
Examples:
Example: Wrap a new div around all of the paragraphs.
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
|
|
Example: Wraps a newly created tree of objects around the spans. Notice anything in between the spans gets left out like the <strong> (red text) in this example. Even the white space between spans is left out. Click View Source to see the original html.
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
|
|
Example: Wrap a new div around all of the paragraphs.
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
|
|
Example: Wrap a jQuery object double depth div around all of the paragraphs. Notice it doesn't move the object but just clones it to wrap around its target.
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
|
|