Sanitizer: allowAttribute() Methode

Syntax

allowAttribute(attribute)

Parameter

attribute

Ein String, der den Namen des Attributs angibt, das global 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 und standardmäßig null ist.

Rückgabewert

true, wenn der Vorgang die Konfiguration geändert hat, um das Attribut zu erlauben, und false, wenn die Konfiguration das Attribut bereits erlaubt hat.

Beachten Sie, dass false zurückgegeben werden könnte, 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 Erlaubnis 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. Dann rufen wir 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 jetzt in die attributes Liste aufgenommen wurden (andere Attribute werden nicht auf Elementen erlaubt, wenn der Sanitizer verwendet wird).

Spezifikationen

Browser-Kompatibilität