Range: surroundContents() method
The Range.surroundContents() method moves content of the Range into a new node, placing the new node at the start of the specified range.
This method is nearly equivalent to newNode.appendChild(range.extractContents()); range.insertNode(newNode). After surrounding, the boundary points of the range include newNode.
An exception will be thrown, however, if the Range splits a non-Text node with only one of its boundary points. That is, unlike the alternative above, if there are partially selected nodes, they will not be cloned and instead the operation will fail.
Syntax
surroundContents(newParent)
Parameters
-
newParent
-
A Node with which to surround the contents.
Return value
Examples
HTML
<span class="header-text">Put this in a headline</span>
JavaScript
const range = document.createRange();
const newParent = document.createElement("h1");
range.selectNode(document.querySelector(".header-text"));
range.surroundContents(newParent);
Result
Specifications
Browser compatibility
|
Desktop |
Mobile |
|
Chrome |
Edge |
Firefox |
Internet Explorer |
Opera |
Safari |
WebView Android |
Chrome Android |
Firefox for Android |
Opera Android |
Safari on IOS |
Samsung Internet |
surroundContents |
1 |
12 |
1 |
9 |
9 |
1 |
4.4 |
18 |
4 |
10.1 |
1 |
1.0 |
See also