Range.surroundContents()

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

range.surroundContents(newParent);

Parameters

newParent

A Node with which to surround the contents.

Example

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

Specification
DOM Standard (DOM)
# dom-range-surroundcontents

Browser compatibility

BCD tables only load in the browser

See also