CodePlayer

replaceWith()函数用于使用指定的元素替换每个匹配的元素。

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

语法

jQuery 1.2 新增该函数。

jQueryObject.replaceWith( replacement )

参数

如果参数replacement为字符串，则将其视作html字符串。

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

replaceWith()还会为函数传入两个参数：第一个参数就是当前元素在匹配元素中的索引，第二个参数就是该元素当前的内部html内容(innerHTML)。函数的返回值就是用于替换的内容(可以是html字符串、DOM元素、jQuery对象)。

返回值

replaceWith()函数的返回值为jQuery类型，返回当前jQuery对象本身(虽然其匹配的元素已从文档中被移除)。

与被替换掉的节点关联的所有数据和事件处理器也将同时被移除。

注意：如果replacement元素是当前页面中的元素，则该元素将从原位置上消失。这相当于一个移动操作，而不是一个复制操作。

示例&说明

replaceWith()函数用于在每个匹配元素的所有内容外部包裹指定的元素：

<p>段落文本1<span></span></p>
<p>段落文本2<span></span></p>

<script type="text/javascript">
$("p").replaceWith( '<em></em>' ); 
</script>

<!--以下是jQuery代码执行后的html内容-->
<em></em>
<em></em>

请注意replaceWith()和replaceAll()函数之间的区别：

var $A = $("s1");
var $B = $("s2");


// 将$A替换成$B
$A.replaceWith( $B ); // 返回$A
// 将$B替换成$A
$A.replaceAll( $B ); // 返回表示替换内容的jQuery对象( 匹配替换掉$B的所有$A元素 )

请参考下面这段HTML代码(原HTML代码)：

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

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

// 将所有span元素替换为指定的em元素
$("span").replaceWith( '<em class="new">替代元素</em>' );

// 将n6替换为n4
// n4将从原位置上消失
$("#n6").replaceWith( $("#n4") );

// 将所有p元素替换为div元素
$("p").replaceWith( function(i, innerHTML){
	return '<div class="thread-' + (i + 1) + '">' + innerHTML + '</div>';		
} );

运行代码

以下是jQuery代码执行后的html内容(格式未作任何调整)：

<div class="thread-1">
	<em class="new">替代元素</em>    
</div>
<div class="thread-2">
	
	<em class="new">替代元素</em>
</div>
<label id="n4">[label#n4]</label>