ShadowRoot: getHTML() method

{{APIRef("DOM")}}

The getHTML() method of the {{domxref("ShadowRoot")}} interface is used to serialize a shadow root's DOM to an HTML string.

The method provides an options argument that enables the serialization of child nodes that are shadow roots. The options can be used to include nested shadow roots that have been set as {{domxref("ShadowRoot/serializable","serializable")}}, and/or a specified array of {{domxref("ShadowRoot")}} objects, which may be either open or closed.

Without arguments, child nodes that are shadow roots are not serialized, and this method behaves in the same way as reading the value of {{domxref("Element.innerHTML")}}.

Note that some browsers serialize the < and > characters as < and > when they appear in attribute values (see Browser compatibility). This is to prevent a potential security vulnerability (mutation XSS) in which an attacker can craft input that bypasses a sanitization function, enabling a cross-site scripting (XSS) attack.

Syntax

getHTML(options)

Parameters

• options {{optional_inline}}
  • : An options object with the following optional parameters:
    • serializableShadowRoots
      • : A boolean value that specifies whether to include serializable shadow roots. The default value is false.
    • shadowRoots
      • : An array of {{domxref("ShadowRoot")}} objects to serialize. These are included regardless of whether they are marked as serializable, or if they are open or closed. The default value is an empty array.

Return value

A string that represents the HTML serialization of the shadow root.

Exceptions

None.

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See Also

• {{domxref("Element.getHTML()")}}
• {{domxref("Element.innerHTML")}}
• {{domxref("ShadowRoot.setHTMLUnsafe()")}}
• {{domxref("Element.setHTMLUnsafe()")}}