ShadowRoot: getHTML()-Methode
Baseline
2024
Neu verfügbar
Seit September 2024 funktioniert diese Funktion auf aktuellen Geräten und in aktuellen Browserversionen. Auf älteren Geräten oder in älteren Browsern funktioniert sie möglicherweise nicht.
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 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 bestimmtes 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 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-Kompatibilität). Dies soll eine potenzielle Sicherheitslücke verhindern (mutation XSS), bei der ein Angreifer Eingaben erstellen kann, die eine Sanisierungsfunktion umgehen und so einen Cross-Site Scripting (XSS)-Angriff ermöglichen.
Syntax
getHTML(options)
Parameter
optionsOptional-
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 unabhängig davon eingeschlossen, ob sie alsserializablemarkiert sind oder ob sie offen oder geschlossen sind. Der Standardwert ist ein leeres Array.
Rückgabewert
Ein String, der die HTML-Serialisierung der Shadow-Root darstellt.
Ausnahmen
Keine.
Spezifikationen
| Spezifikation |
|---|
| HTML # dom-shadowroot-gethtml |