Element: 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 der Element Schnittstelle wird verwendet, um das DOM eines Elements in einen HTML-String zu serialisieren.

Die Methode bietet ein Optionsargument, das die Serialisierung von Knoten 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 Knoten, die Shadow Roots sind, nicht serialisiert, und diese Methode verhält sich wie das Auslesen des Werts von Element.innerHTML.

Beachten Sie, dass einige Browser die < und > Zeichen als &lt; und &gt; serialisieren, wenn sie in Attributwerten erscheinen (siehe Browser-Kompatibilität). Dies soll eine potenzielle Sicherheitslücke (mutation XSS) verhindern, bei der ein Angreifer Eingaben erstellen kann, die eine Sanisierungsfunktion umgehen und damit eine Cross-Site-Scripting (XSS)-Attacke ermöglichen.

Syntax

js
getHTML(options)

Parameter

options Optional

Ein Optionsobjekt mit den folgenden optionalen Parametern:

serializableShadowRoots

Ein boolescher Wert, der angibt, ob serializable 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 als serializable markiert oder ob sie offen oder geschlossen sind. Der Standardwert ist ein leeres Array.

Rückgabewert

Ein String, der die HTML-SERIALISIERUNG des Elements darstellt.

Ausnahmen

Keine.

Spezifikationen

Specification
HTML
# dom-element-gethtml

Browser-Kompatibilität

Siehe auch