Sanitizer: removeElement()-Methode

Syntax

removeElement(element)

Parameter

element

Ein String, der den Namen des nicht erlaubten 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 Namespace des Elements enthält. Der Standard-Namespace ist "http://www.w3.org/1999/xhtml".

Rückgabewert

true, wenn die Operation die Konfiguration geändert hat, um das Element nicht zu erlauben, und false, wenn das Element bereits nicht erlaubt war.

Beachten Sie, dass false zurückgegeben werden kann, wenn die interne Konfiguration:

• ein elements-Array definiert und das Element bereits weggelassen wird (es muss nicht entfernt werden)
• stattdessen ein removeElements-Array definiert und das angegebene Element bereits vorhanden ist (und daher bereits gefiltert wird)

Beispiele

Anleitung zum Nicht-Erlauben von Elementen

Dieses Beispiel zeigt, wie removeElement() verwendet wird, um ein Element als "nicht erlaubt" zu spezifizieren.

<pre id="log"></pre>

#log {
  height: 420px;
  overflow: scroll;
  padding: 0.5rem;
  border: 1px solid black;
}

const logElement = document.querySelector("#log");
function log(text) {
  logElement.textContent = text;
}

JavaScript

Der Code erstellt zuerst ein neues Sanitizer-Objekt, das anfänglich <div>- und <script>-Elemente zulässt und <span>-Elemente durch ihre Kind-Elemente ersetzt.

Der Code ruft dann removeElement() auf, um <p>, <script>- und <span>-Elemente zur removeElements-Liste in der Konfiguration hinzuzufügen. Beachten Sie, dass das Hinzufügen von <script> und <span> die Elemente aus ihren ursprünglichen Listen entfernt.

if ("Sanitizer" in window) {

// Create sanitizer using SanitizerConfig
const sanitizer = new Sanitizer({
  elements: ["div", "script"],
  replaceWithChildrenElements: ["span"],
});

// Disallow the <p> element
sanitizer.removeElement("p");

// Disallow the <script> element
sanitizer.removeElement("script");
// Disallow the <span> element
sanitizer.removeElement("span");

// Log the sanitizer configuration
let sanitizerConfig = sanitizer.get();
log(JSON.stringify(sanitizerConfig, null, 2));

} else {
  log("The HTML Sanitizer API is NOT supported in this browser.");
}

Ergebnisse

Die endgültige Konfiguration wird unten protokolliert.

Spezifikationen

Browser-Kompatibilität