ShadowRoot: getHTML()-Methode

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.

Die getHTML()-Methode des ShadowRoot-Interfaces wird verwendet, um den DOM eines Shadow-Roots als HTML-String zu serialisieren.

Die Methode bietet ein Optionsargument, das die Serialisierung von Kindknoten ermöglicht, die Shadow-Roots sind. Die Optionen können verwendet werden, um verschachtelte Shadow-Roots einzuschließen, die als serializable festgelegt wurden, und/oder ein angegebenes Array von ShadowRoot-Objekten, die entweder offen oder geschlossen sein können.

Ohne Argumente werden Kindknoten, die Shadow-Roots sind, nicht serialisiert, und diese Methode verhält sich genauso wie das Auslesen des Wertes von Element.innerHTML.

Syntax

js
const html = shadowRoot.getHTML(options)

Parameter

options Optional

Ein Optionsobjekt mit den folgenden optionalen Parametern:

serializableShadowRoots

Ein boolescher Wert, der angibt, ob serialisierbare Shadow-Roots eingeschlossen werden sollen. Der Standardwert ist false.

shadowRoots

Ein Array von ShadowRoot-Objekten, die zu serialisieren sind. Diese werden unabhängig davon eingeschlossen, ob sie als serializable markiert sind oder ob sie offen oder geschlossen sind. Der Standardwert ist ein leeres Array.

Rückgabewert

Ein String, der die HTML-Serialisierung des Shadow-Roots darstellt.

Ausnahmen

Keine.

Spezifikationen

Specification
HTML Standard
# dom-shadowroot-gethtml

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch