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 Schattenwurzeln sind. Die Optionen können verwendet werden, um verschachtelte Schattenwurzeln 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 Schattenwurzeln sind, nicht serialisiert, und diese Methode verhält sich in der gleichen Weise wie das Auslesen des Wertes von Element.innerHTML.

Beachten Sie, dass einige Browser die < und > Zeichen als &lt; und &gt; serialisieren, wenn sie in Attributwerten vorkommen (siehe Browser-Kompatibilität). Dies dient der Vermeidung einer potenziellen Sicherheitslücke (mutation XSS), bei der ein Angreifer Eingaben gestalten kann, die eine Sanisierungsfunktion umgehen und 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 Schattenwurzeln enthalten sein sollen. Der Standardwert ist false.

shadowRoots

Ein Array von ShadowRoot Objekten, die serialisiert werden sollen. Diese werden unabhängig davon eingeschlossen, ob sie als serializable markiert sind 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