ShadowRoot: getHTML()-Methode
Baseline 2024Newly 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 das DOM eines Shadow-Roots zu einem 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 geschachtelte Shadow-Roots einzuschließen, die als serializable
festgelegt sind, 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 genauso wie das Lesen des Werts von Element.innerHTML
.
Beachten Sie, dass einige Browser die Zeichen <
und >
als <
und >
serialisieren, wenn sie in Attributwerten vorkommen (siehe Browser-Kompatibilität). Dies dient zur Vermeidung eines potenziellen Sicherheitsrisikos (mutation XSS), bei dem ein Angreifer Eingaben erstellen kann, die eine Sanitierungsfunktion umgehen, was einen Cross-Site-Scripting-Angriff (XSS) ermöglicht.
Syntax
getHTML(options)
Parameter
options
Optional-
Ein Optionsobjekt mit den folgenden optionalen Parametern:
serializableShadowRoots
-
Ein boolescher Wert, der angibt, ob serializable Shadow-Roots einbezogen werden sollen. Der Standardwert ist
false
. shadowRoots
-
Ein Array von
ShadowRoot
-Objekten, die serialisiert werden sollen. Diese werden unabhängig davon aufgenommen, ob sie alsserializable
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 # dom-shadowroot-gethtml |