jQuery.wrapAll() 函数详解

wrapAll()函数用于在所有匹配元素用单个元素包裹起来。

该函数属于jQuery对象(实例)。

语法

jQuery 1.2 新增该函数。

jQueryObject.wrapAll( wrapper )

参数

参数 描述

wrapper String/Element/jQuery/Function类型用于包裹匹配元素的节点。

如果参数wrapper为字符串，则将其视作jQuery选择器或html字符串，jQuery会自行判断。

如果wrapper不是函数类型，wrapAll()会将所有匹配元素移动到第一个匹配元素的位置，然后用指定的单个元素将它们全部包裹起来。

jQuery 1.4 新增支持：参数wrapper可以为函数。wrapAll()将根据匹配的所有元素遍历执行该函数，函数中的this将指向对应的DOM元素。

wrapAll()还会为函数传入一个参数，即当前元素在匹配元素中的索引。函数的返回值就是用于包裹的节点内容(可以是html字符串、DOM元素或jQuery对象)。

注意：如果wrapper匹配多个元素，则只将第一个元素作为包裹元素。

注意：如果wrapper是多层嵌套的元素(例如"<p><i></i></p>")，wrapAll()将从外往内检查每层嵌套的第一个节点。如果该节点没有子节点或者第一个子节点不是Element节点(比如文本节点、注释节点等)，就停止向内查找，直接在当前节点内部的末尾位置追加(append())当前匹配元素。

返回值

wrapAll()函数的返回值为jQuery类型，返回当前jQuery对象本身(以便于进行链式风格的编程)。

注意：即使wrapper元素是当前页面中的元素，该元素也不会从原位置上消失。因为wrapAll()使用的是该元素的副本(克隆)来充当包裹元素。

示例&说明

wrapAll()函数用于将所有匹配元素用单个元素包裹起来：

<p>段落文本1<span></span></p>
<p>段落文本2<span></span></p>
<script type="text/javascript">
$("p").wrapAll( '<div></div>' ); 
</script>
<!--以下是jQuery代码执行后的html内容-->
<div><p>段落文本1<span></span></p><p>段落文本2<span></span></p></div>

以下面这段HTML代码为例：

<p id="n1">
    <span id="n2">[span#n2]</span>    
</p>
<p id="n3">
    <label id="n4">[label#n4]</label>
</p>
<span id="n5">[span#n5]</span>
<span id="n6">[span#n6]</span>

以下jQuery示例代码用于演示wrapAll()函数的具体用法：

// 在n4元素外包裹del元素：<del>{#n4}</del>
$("#n4").wrapAll('<del/>');
// 在所有span元素外包裹单个em元素：<em class="all-span">{#n2}{#n5}{#n6}</em>
// 所有span元素会先移动到第一个span元素的位置，然后全部被em元素包裹起来
$("span").wrapAll('<em class="all-span"></em>');
运行代码(其他代码请自行复制到演示页面运行)
wrapAll()会将包裹元素的开始标记和结束标记分别置于所有匹配元素的两侧，不会额外添加任何空白字符，上述代码执行后的完整html代码如下(格式未作任何调整)：
<p id="n1">
    <em class="all-span"><span id="n2">[span#n2]</span><span id="n5">[span#n5]</span><span id="n6">[span#n6]</span></em>    
</p>
<p id="n3">
    <del><label id="n4">[label#n4]</label></del>
</p>

下面是参数wrapper为函数的jQuery示例代码，：

<p id="n1">
    <span id="n2">[span#n2]</span>    
</p>
<p id="n3">
    <label id="n4">[label#n4]</label>
</p>
<span id="n5">[span#n5]</span>
<span id="n6">[span#n6]</span>
<!--以上是执行jQuery代码前的html内容-->
<script type="text/javascript">
// 在所有span元素外包裹单个em元素：<em class="level-index">{span}</em>
// 由于参数是函数，因此所有span元素不会移动到一起
$("span").wrapAll( function(index){
    return '<em class="level-' + index + '"></em>'; 
} ); 
</script>
<!--以上是执行jQuery代码后的html内容-->
<p id="n1">
    <em class="level-0"><span id="n2">[span#n2]</span></em>    
</p>
<p id="n3">
    <label id="n4">[label#n4]</label>
</p>
<em class="level-1"><span id="n5">[span#n5]</span></em>
<em class="level-2"><span id="n6">[span#n6]</span></em>

以下是wrapper参数为多层嵌套元素的jQuery示例代码：

<span id="n1">[span#n1]</span>
<label id="n2">[label#n2]</label>
<span id="n3">[span#n3]</span>
<!--以上是执行jQuery代码前的html内容-->
<script type="text/javascript">
// 在所有span元素外包裹嵌套的div元素：<div><p><em>{#n1}{#n3}</em></p></div>
// 所有span元素都会移动到第一个span元素的位置
$("span").wrapAll( '<div><p><em></em></p></div>' );
/*
如果参数为'<div><p> <em></em></p></div>'，由于'<p>'的第一个子节点是空格(文本节点)，因此停止向内层查找，直接在p元素内部的末尾位置插入所有的span元素：<div><p> <em></em>{#n1}{#n3}</p></div>
 */
</script>
<!--以上是执行jQuery代码后的html内容-->
<div><p><em><span id="n1">[span#n1]</span><span id="n3">[span#n3]</span></em></p></div>
<label id="n2">[label#n2]</label>

以上就是jQuery.wrapAll() 函数详解的详细内容，更多请关注其它相关文章！