DOMTokenList

The DOMTokenList interface represents a set of space-separated tokens. Such a set is returned by Element.classList, HTMLLinkElement.relList, HTMLAnchorElement.relList or HTMLAreaElement.relList. It is indexed beginning with 0 as with JavaScript Array objects. DOMTokenList is always case-sensitive.

Properties

This interface doesn't inherit any property.

DOMTokenList.length Read only

Is an integer representing the number of objects stored in the object.

Methods

This interface doesn't inherit any method.

DOMTokenList.item()

Returns an item in the list by its index (or undefined if the number is greater than or equal to the length of the list, prior to Gecko 7.0 returned null)

DOMTokenList.contains()

Returns true if the underlying string contains token, otherwise false

DOMTokenList.add()

Adds token to the underlying string

DOMTokenList.remove()

Removes token from the underlying string

DOMTokenList.replace()

Replaces an existing token with a new token.

DOMTokenList.supports()

Returns true if a given token is in the associated attribute's supported tokens.

DOMTokenList.toggle()

Removes token from string and returns false. If token doesn't exist it's added and the function returns true

DOMTokenList.entries()

Returns an iterator allowing to go through all key/value pairs contained in this object.

DOMTokenList.forEach()

Executes a provided function once per DOMTokenList element.

DOMTokenList.keys()

Returns an iterator allowing to go through all keys of the key/value pairs contained in this object.

DOMTokenList.values()

Returns an iterator allowing to go through all values of the key/value pairs contained in this object.

Specifications

Specification	Status	Comment
DOM The definition of 'DOMTokenList' in that specification.	Living Standard	Initial definition

Browser compatibility

See Also

• DOMSettableTokenList (object that extends DOMTokenList with settable .value property)