DOMTokenList
BaselineWidely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.
TheDOMTokenList
interface represents a set of space-separated tokens. Such a set is returned byElement.classList
orHTMLLinkElement.relList
, and many others.
ADOMTokenList
is indexed beginning with0
as with JavaScriptArray
objects.DOMTokenList
is always case-sensitive.
Instance properties
DOMTokenList.length
Read onlyAn
integer
representing the number of objects stored in the object.DOMTokenList.value
Astringifier property that returns the value of the list as a string.
Instance methods
DOMTokenList.item()
Returns the item in the list by its index, or
null
if the index is greater than or equal to the list'slength
.DOMTokenList.contains()
Returns
true
if the list contains the given token, otherwisefalse
.DOMTokenList.add()
Adds the specified tokens to the list.
DOMTokenList.remove()
Removes the specified tokens from the list.
DOMTokenList.replace()
Replaces the token with another one.
DOMTokenList.supports()
Returns
true
if the given token is in the associated attribute's supported tokens.DOMTokenList.toggle()
Removes the token from the list if it exists, or adds it to the list if it doesn't. Returns a boolean indicating whether the token is in the list after the operation.
DOMTokenList.entries()
Returns aniterator, allowing you to go through all key/value pairs contained in this object.
DOMTokenList.forEach()
Executes a provided callback function once for each
DOMTokenList
element.DOMTokenList.keys()
Returns aniterator, allowing you to go through all keys of the key/value pairs contained in this object.
DOMTokenList.toString()
Returns the
DOMTokenList.value
, the space-separated values of the list as a string.DOMTokenList.values()
Returns aniterator, allowing you to go through all values of the key/value pairs contained in this object.
Examples
In the following simple example, we retrieve the list of classes set on a<p>
element as aDOMTokenList
usingElement.classList
, add a class usingDOMTokenList.add()
, and then update theNode.textContent
of the<p>
to equal theDOMTokenList
.
First, the HTML:
<p></p>
Now the #"p");let classes = para.classList;para.classList.add("d");para.textContent = `paragraph classList is "${classes}"`;
The output looks like this: