DOMTokenList: contains() method

{{APIRef("DOM")}}

The contains() method of the {{domxref("DOMTokenList")}} interface returns a boolean value — true if the underlying list contains the given token, otherwise false.

Syntax

contains(token)

Parameters

• token
  • : A string representing the token you want to check for the existence of in the list.

Return value

A boolean value, which is true if the calling list contains token, otherwise false.

Examples

In the following example we retrieve the list of classes set on a {{htmlelement("span")}} element as a DOMTokenList using {{domxref("Element.classList")}}. We then test for the existence of "c" in the list, and write the result into the <span>'s {{domxref("Node.textContent")}}.

First, the HTML:

<span class="a b c"></span>

Now the JavaScript:

const span = document.querySelector("span");
span.textContent = span.classList.contains("c")
  ? "The classList contains 'c'"
  : "The classList does not contain 'c'";

The output looks like this:

{{ EmbedLiveSample('Examples', '100%', 60) }}

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}