ShadowRoot: getHTML() method
Baseline 2024
Newly available
Since September 2024, this feature works across the latest devices and browser versions. This feature might not work in older devices or browsers.
The getHTML()
method of the 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 serializable
, and/or a specified array of 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 Element.innerHTML
.
Syntax
const html = shadowRoot.getHTML(options)
Parameters
options
Optional-
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
ShadowRoot
objects to serialize. These are included regardless of whether they are marked asserializable
, 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
Specification |
---|
HTML Standard # dom-shadowroot-gethtml |
Browser compatibility
BCD tables only load in the browser