Element: innerHTML property
Baseline Widely available *
This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.
* Some parts of this feature may have varying levels of support.
Warning:This property parses its input as HTML, writing the result into the DOM.APIs like this are known asinjection sinks, and are potentially a vector forcross-site scripting (XSS) attacks, if the input originally came from an attacker.
You can mitigate this risk by always assigningTrustedHTML objects instead of strings andenforcing trusted types.SeeSecurity considerations for more information.
TheinnerHTML property of theElement interface gets or sets the HTML or XML markup contained within the element, omitting anyshadow roots in both cases.
To insert the HTML into the document rather than replace the contents of an element, use the methodinsertAdjacentHTML().
In this article
Value
Getting the property returns a string containing the HTML serialization of the element's descendants.
Setting the property accepts either aTrustedHTML object or a string. It parses this value as HTML and replaces all the element's descendants with the result.When set to thenull value, thatnull value is converted to the empty string (""), soelt.innerHTML = null is equivalent toelt.innerHTML = "".
Exceptions
SyntaxErrorDOMExceptionThrown if an attempt was made to set the value of
innerHTMLusing a string which is not properly-formed HTML.TypeErrorThrown if the property is set to a string whenTrusted Types areenforced by a CSP and no default policy is defined.
NoModificationAllowedErrorDOMExceptionThrown if an attempt was made to insert the HTML into a node whose parent is a
Document.
Description
innerHTML gets a serialization of the nested child DOM elements within the element, or sets HTML or XML that should be parsed to replace the DOM tree within the element.
Note that some browsers serialize the< and> characters as< and> when they appear in attribute values (seeBrowser compatibility).This is to prevent a potential security vulnerability (mutation XSS) in which an attacker can craft input that bypasses asanitization function, enabling a cross-site scripting (XSS) attack.
Shadow DOM considerations
The serialization of the DOM tree read from the property does not includeshadow roots — if you want to get a HTML string that includes shadow roots, you must instead use theElement.getHTML() orShadowRoot.getHTML() methods.
Similarly, when setting element content usinginnerHTML, the HTML string is parsed into DOM elements that do not contain shadow roots.So for example<template> is parsed into asHTMLTemplateElement, whether or not theshadowrootmode attribute is specified.In order to set an element's contents from an HTML string that includes declarative shadow roots, you must instead useElement.setHTMLUnsafe() orShadowRoot.setHTMLUnsafe().
Security considerations
TheinnerHTML property is probably the most common vector forcross-site scripting (XSS) attacks, where potentially unsafe strings provided by a user are injected into the DOM without first being sanitized.While the property does prevent<script> elements from executing when they are injected, it is susceptible to many other ways that attackers can craft HTML to run malicious JavaScript.For example, the following example would execute the code in theerror event handler, because the<img>src value is not a valid image URL:
const name = "<img src='x' onerror='alert(1)'>";el.innerHTML = name; // shows the alertYou can mitigate these issues by always assigningTrustedHTML objects instead of strings, andenforcing trusted types using therequire-trusted-types-for CSP directive.This ensures that the input is passed through a transformation function, which has the chance tosanitize the input to remove potentially dangerous markup before it is injected.
Note:Node.textContent should be used when you know that the user provided content should be plain text.This prevents it being parsed as HTML.
Examples
>Reading the HTML contents of an element
ReadinginnerHTML causes the user agent to serialize the element's descendants.
Given the following HTML:
<div> <p>My name is Joe</p></div>You can get and log the markup for the contents of the outer<div> as shown:
const myElement = document.querySelector("#example");const contents = myElement.innerHTML;console.log(contents); // "\n <p>My name is Joe</p>\n"Replacing the contents of an element
In this example we'll replace an element's DOM by assigning HTML to the element'sinnerHTML property.To mitigate the risk of XSS, we'll first create aTrustedHTML object from the string containing the HTML, and then assign that object toinnerHTML.
Trusted types are not yet supported on all browsers, so first we define thetrusted types tinyfill.This acts as a transparent replacement for the Trusted Types JavaScript API:
if (typeof trustedTypes === "undefined") trustedTypes = { createPolicy: (n, rules) => rules };Next we create aTrustedTypePolicy that defines acreateHTML() for transforming an input string intoTrustedHTML instances.Commonly implementations ofcreateHTML() use a library such asDOMPurify to sanitize the input as shown below:
const policy = trustedTypes.createPolicy("my-policy", { createHTML: (input) => DOMPurify.sanitize(input),});Then we use thispolicy object to create aTrustedHTML object from the potentially unsafe input string, and assign the result to the element:
// The potentially malicious stringconst untrustedString = "<p>I might be XSS</p><img src='x' onerror='alert(1)'>";// Create a TrustedHTML instance using the policyconst trustedHTML = policy.createHTML(untrustedString);// Inject the TrustedHTML (which contains a trusted string)const element = document.querySelector("#container");element.innerHTML = trustedHTML;Warning:While you can directly assign a string toinnerHTML this is asecurity risk if the string to be inserted might contain potentially malicious content.You should useTrustedHTML to ensure that the content is sanitized before it is inserted, and you should set a CSP header toenforce trusted types.
Specifications
| Specification |
|---|
| HTML> # dom-element-innerhtml> |
Browser compatibility
See also
Node.textContentandHTMLElement.innerTextElement.insertAdjacentHTML()Element.outerHTML- Parsing HTML or XML into a DOM tree:
DOMParser - Serializing a DOM tree into an XML string:
XMLSerializer Element.getHTML()ShadowRoot.getHTML()Element.setHTMLUnsafe()ShadowRoot.setHTMLUnsafe()- Trusted Types API