ShadowRoot: getHTML()-Methode

Baseline 2024

Neu verfgbar

Seit September 2024 funktioniert diese Funktion auf aktuellen Gerten und in aktuellen Browserversionen. Auf lteren Gerten oder in lteren Browsern funktioniert sie mglicherweise nicht.

Mehr erfahren
Vollstndige Kompatibilitt anzeigen

Die getHTML()-Methode der ShadowRoot-Schnittstelle wird verwendet, um das DOM einer Shadow-Root in einen HTML-String zu serialisieren.

Die Methode bietet ein Optionsargument, das die Serialisierung von Kindknoten ermglicht, die Shadow-Roots sind. Die Optionen knnen verwendet werden, um verschachtelte Shadow-Roots einzuschlieen, die als serializable festgelegt wurden, und/oder ein bestimmtes Array von ShadowRoot-Objekten, die entweder offen oder geschlossen sein knnen.

Ohne Argumente werden Kindknoten, die Shadow-Roots sind, nicht serialisiert, und diese Methode verhlt sich in gleicher Weise wie das Lesen des Wertes von Element.innerHTML.

Beachten Sie, dass einige Browser die <- und >-Zeichen als < und > serialisieren, wenn sie in Attributwerten erscheinen (siehe Browser-Kompatibilitt). Dies soll eine potenzielle Sicherheitslcke verhindern (mutation XSS), bei der ein Angreifer Eingaben erstellen kann, die eine Sanisierungsfunktion umgehen und so einen Cross-Site Scripting (XSS)-Angriff ermglichen.

Syntax

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 serialisiert werden sollen. Diese werden unabhngig davon eingeschlossen, ob sie als serializable markiert sind oder ob sie offen oder geschlossen sind. Der Standardwert ist ein leeres Array.