Sanitizer: allowAttribute() Methode

Syntax

allowAttribute(attribute)

Parameter

attribute

Ein String, der den Namen des Attributs angibt, das weltweit auf Elementen erlaubt sein soll, oder ein Objekt mit den folgenden Eigenschaften:

name

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

namespace Optional

Ein String, der den Namensraum des Attributs enthält, der standardmäßig auf null gesetzt ist.

Rückgabewert

true, wenn die Operation die Konfiguration geändert hat, um das Attribut zuzulassen, und false, wenn die Konfiguration das Attribut bereits erlaubte.

false könnte zurückgegeben werden, wenn die interne Konfiguration:

• ein attributes Array definiert und das Attribut bereits vorhanden ist (es muss nicht erneut hinzugefügt werden)
• stattdessen das removeAttributes Array definiert und das angegebene Attribut nicht vorhanden ist (und daher bereits erlaubt ist)
• dataAttributes auf true gesetzt ist, aber ein data-* Attribut übergeben wird.

Beispiele

Anleitung zur Zulassung spezifischer Attribute auf Elementen

Dieses Beispiel zeigt, wie allowAttribute() verwendet wird, um festzulegen, dass ein Attribut auf Elementen erlaubt ist.

<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 zunächst ein neues Sanitizer Objekt, das anfänglich keine Attribute erlaubt. Wir rufen dann allowAttribute() mit den Attributen title und mathcolor auf.

if ("Sanitizer" in window) {

// Create an allow sanitizer
const sanitizer = new Sanitizer({
  attributes: [],
});

// Allow the "title" attribute
sanitizer.allowAttribute("title");
// Allow the "mathcolor" attribute
sanitizer.allowAttribute("mathcolor");

// 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. Beachten Sie, wie beide Attribute nun zur attributes Liste hinzugefügt sind (andere Attribute werden bei Verwendung des Sanitizers auf Elementen nicht erlaubt).

Spezifikationen

Browser-Kompatibilität