TheparseHTML() static method of theDocument object provides an XSS-safe method to parse and sanitize a string of HTML in order to create a newDocument instance.

Syntax

Document.parseHTML(input)Document.parseHTML(input, options)

Parameters

input

A string defining HTML to be sanitized and injected into the shadow root.

optionsOptional

An options object with the following optional parameters:

sanitizer

ASanitizer orSanitizerConfig object which defines what elements of the input will be allowed or removed, or the string"default" for the default sanitizer configuration.Note that generally a"Sanitizer is expected to be more efficient than aSanitizerConfig if the configuration is to reused.If not specified, the XSS-safe default sanitizer configuration is used.

Return value

ADocument.

Exceptions

TypeError

This is thrown ifoptions.sanitizer is passed a:

• non-normalizedSanitizerConfig (one that includes both "allowed" and "removed" configuration settings).
• string that does not have the value"default".
• value that is not aSanitizer,SanitizerConfig, or string.

Description

TheparseHTML() method parses and sanitize a string of HTML in order to create a newDocument instance that is XSS-safe.The resultingDocument will have acontent type of "text/html", acharacter set of UTF-8, and a URL of "about:blank".

If no sanitizer configuration is specified in theoptions.sanitizer parameter,parseHTML() is used with the defaultSanitizer configuration.This configuration allows all elements and attributes that are considered XSS-safe, thereby disallowing entities that are considered unsafe.A custom sanitizer or sanitizer configuration can be specified to choose which elements, attributes, and comments are allowed or removed.Note that even if unsafe options are allowed by the sanitizer configuration, they will still be removed when using this method (which implicitly callsSanitizer.removeUnsafe()).

The input HTML may includedeclarative shadow roots.If the string of HTML defines more than onedeclarative shadow root in a particular shadow host then only the firstShadowRoot is created — subsequent declarations are parsed as<template> elements within that shadow root.

parseHTML() should be used instead ofDocument.parseHTMLUnsafe(), unless there is a specific need to allow unsafe elements and attributes.If the HTML to be parsed doesn't need to contain unsafe HTML entities, then you should useDocument.parseHTML().

Note that since this method always sanitizes input strings of XSS-unsafe entities, it is not secured or validated using theTrusted Types API.

Specifications

Browser compatibility

See also

• Document.parseHTMLUnsafe()
• Element.setHTML() andElement.setHTMLUnsafe()
• ShadowRoot.setHTML() andShadowRoot.setHTMLUnsafe()
• DOMParser.parseFromString() for parsing HTML or XML into a DOM tree
• HTML Sanitizer API