The outerHTML
attribute of the Element
DOM interface gets the serialized HTML fragment describing the element including its descendants. It can also be set to replace the element with nodes parsed from the given string.
To only obtain the HTML representation of the contents of an element, or to replace the contents of an element, use the innerHTML
property instead.
Reading the value of outerHTML
returns a DOMString
containing an HTML serialization of the element
and its descendants. Setting the value of outerHTML
replaces the element and all of its descendants with a new DOM tree constructed by parsing the specified htmlString
.
Getting the value of an element's outerHTML
property:
<div id="d">
<p>Content</p>
<p>Further Elaborated</p>
</div>
var d = document.getElementById("d");
console.log(d.outerHTML);
Replacing a node by setting the outerHTML
property:
<div id="container">
<div id="d">This is a div.</div>
</div>
var container = document.getElementById("container");
var d = document.getElementById("d");
console.log(container.firstElementChild.nodeName);
d.outerHTML = "<p>This paragraph replaced the original div.</p>";
console.log(container.firstElementChild.nodeName);
If the element has no parent element, setting its outerHTML
property will not change it or its descendants. Many browsers will also throw an exception. For example:
var div = document.createElement("div");
div.outerHTML = "<div class=\"test\">test</div>";
console.log(div.outerHTML);
Also, while the element will be replaced in the document, the variable whose outerHTML
property was set will still hold a reference to the original element:
var p = document.getElementsByTagName("p")[0];
console.log(p.nodeName);
p.outerHTML = "<div>This div replaced a paragraph.</div>";
console.log(p.nodeName);
The returned value will contain HTML escaped attributes:
var anc = document.createElement("a");
anc.href = "https://developer.mozilla.org?a=b&c=d";
console.log(anc.outerHTML);