Firefox Tomorrow

web api instance method

Range: surroundContents() method

View on MDN ↗

The surroundContents() method of the Range interface surrounds the selected content by a provided node. It extracts the contents of the range, replaces the children of newParent with the extracted contents, inserts newParent at the location of the extracted contents, and makes the range select newParent.

An exception is thrown if the range partially contains any non-Text node. The range must only contain text nodes and completely selected nodes.

Syntax

surroundContents(newParent)

Parameters

  • newParent
    • : A Node with which to surround the contents.

Return value

None (undefined).

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

Interactive exampleOpen the canonical MDN source to run this embedded demo.

Specifications

SpecificationsStandards references are available on the canonical MDN page.

Browser compatibility

Browser compatibilityCompatibility data is available on the canonical MDN page.

See also