Sanitizer: replaceElementWithChildren() Methode

Experimentell: Dies ist eine experimentelle Technologie
Überprüfen Sie die Browser-Kompatibilitätstabelle sorgfältig vor der Verwendung auf produktiven Webseiten.

Die replaceElementWithChildren() Methode der Sanitizer Schnittstelle legt fest, dass ein Element durch seine Kind-HTML-Elemente ersetzt wird, wenn der Sanitizer verwendet wird. Dies wird hauptsächlich verwendet, um Stile aus Text zu entfernen.

Das angegebene Element, zusammen mit seinem Namensraum, wird zur Liste der replaceWithChildrenElements in der Konfiguration dieses Sanitizers hinzugefügt. Das Element wird aus den Listen elements oder removeElements entfernt, falls vorhanden.

Syntax

js
replaceElementWithChildren(element)

Parameter

element

Ein String, der den Namen des zu ersetzenden Elements angibt, oder ein Objekt mit den folgenden Eigenschaften:

name

Ein String, der den Namen des Elements enthält.

namespace Optional

Ein String, der den Namensraum des Elements enthält. Der Standardnamensraum ist "http://www.w3.org/1999/xhtml".

Rückgabewert

Keiner (undefined).

Beispiele

Grundlegende Verwendung

Dieses Beispiel zeigt die grundlegende Verwendung der Methode, indem ein Sanitizer konfiguriert wird, der das <em> Element in Eingaben durch seinen Kindinhalt ersetzt.

js
// Create sanitizer (in this case the default)
const sanitizer = new Sanitizer();

// Replace <em> elements with their innerHTML
sanitizer.replaceElementWithChildren("em");

Anleitung zum Entfernen von Stilen aus Text

Dieses Beispiel zeigt, wie replaceElementWithChildren() verwendet werden kann, um Stile aus Text zu entfernen.

JavaScript

Der Code erstellt zuerst ein neues Sanitizer Objekt, das anfänglich <p>, <em> und <strong> Elemente zulässt. Wir rufen dann replaceElementWithChildren() auf dem Sanitizer auf und geben an, dass <strong> Elemente ersetzt werden sollen.

Der Code definiert einen String, der <strong> Elemente enthält, und verwendet Element.setHTML() mit dem Sanitizer, um den String einzufügen. Der ursprüngliche String, der bereinigte HTML-Inhalt aus dem Element und der Sanitizer werden protokolliert.

js
// Create sanitizer using SanitizerConfig
const sanitizer = new Sanitizer({
  elements: ["p", "em", "strong"],
});

// Replace the <strong> element
sanitizer.replaceElementWithChildren("strong");

const unsanitizedString = `<p>This is a with <strong>important</strong> text <em>highlighted</em>.</p>`;
log(`unsanitizedHTMLString:\n ${unsanitizedString}`);

// Create a <div> element
const divElement = document.createElement("div");

divElement.setHTML(unsanitizedString, { sanitizer });
log(`\n\nsanitizedHTML:\n ${divElement.innerHTML}`);

// Log the sanitizer configuration
const sanitizerConfig = sanitizer.get();
log(`\n\nsanitizerConfig:\n ${JSON.stringify(sanitizerConfig, null, 2)}`);

Ergebnisse

Der ursprüngliche unbereinigte HTML-String, der bereinigte String aus dem Element und der Sanitizer werden unten protokolliert. Beachten Sie, dass die <strong> Formatierung aus dem Text entfernt wird, aber das <em> Element nicht. Beachten Sie auch, dass das <strong> Element ursprünglich in der elements Liste in der Konfiguration war, aber entfernt wurde, als es zur replaceWithChildrenElements Liste hinzugefügt wurde.

Spezifikationen

Specification
HTML Sanitizer API
# dom-sanitizer-replaceelementwithchildren

Browser-Kompatibilität