Sanitizer: setDataAttributes() method

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The setDataAttributes() method of the Sanitizer interface sets whether all data-* attributes will be allowed by the sanitizer, or if they must be individually specified.

If this is set true, then data attributes are automatically allowed without needing to add them individually using Sanitizer.allowAttribute() (or Sanitizer.allowElement() for local attributes).

Syntax

js
setDataAttributes(allow);

Parameters

allow

true if all data-* attributes are allowed, and false if they must be explicitly specified.

Return value

true if the operation changed the configuration, and false if the configuration already set dataAttributes to the specified value.

Examples

How to sanitize data attributes

The code below shows the basic usage of the setDataAttributes() method.

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

// Allow all data-* attributes
sanitizer.setDataAttributes(true);

// Require data-* attributes be added explicitly
sanitizer.setDataAttributes(false);

Specifications

Specification
HTML Sanitizer API
# dom-sanitizer-setdataattributes

Browser compatibility