ShadowRoot: serializable property

Baseline2024

Since September 2024, this feature works across the latest devices and browser versions. This feature might not work in older devices or browsers.

Theserializable read-only property of theShadowRoot interface returnstrue if the shadow root is serializable.

If set, the shadow root may be serialized by calling theElement.getHTML() orShadowRoot.getHTML() methods with theoptions.serializableShadowRoots parameter settrue.

The serializable property of a shadow root is specified when the shadow root is created, either declaratively by adding theshadowrootserializable attribute on a<template> element (along with an allowedshadowrootmode value), or by setting theoptions.serializable parameter totrue when usingElement.attachShadow().

Value

true if the shadow root is serializable;false otherwise.

Examples

const customElem = document.querySelector("my-shadow-dom-element");const shadow = customElem.shadowRoot;// …// Is it serializable?const hostElem = shadow.serializable;