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 der ShadowRoot-Schnittstelle wird verwendet, um den DOM eines Shadow-Roots in einen HTML-String zu serialisieren.
Die Methode bietet ein Options-Argument, 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 auf die gleiche Weise wie das Auslesen des Werts 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 Sicherheitsanfälligkeit (Mutation XSS) verhindern, bei der ein Angreifer Eingaben erstellen kann, die eine Sanitisierungsfunktion umgehen, was einen Cross-Site-Scripting-(XSS)-Angriff ermöglicht.
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 einbezogen, 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 des Shadow-Roots darstellt.
Ausnahmen
Keine.
Spezifikationen
| Specification |
|---|
| HTML # dom-shadowroot-gethtml |