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.prototype.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.prototype.contains()
- Returns
true
if the underlying string contains token, otherwisefalse
DOMTokenList.prototype.add()
- Adds token to the underlying string
DOMTokenList.prototype.remove()
- Removes token from the underlying string
DOMTokenList.prototype.replace()
- Replaces an existing token with a new token.
DOMTokenList.prototype.supports()
- Returns
true
if a given token is in the associated attribute's supported tokens. DOMTokenList.prototype.toggle()
- Removes token from string and returns false. If token doesn't exist it's added and the function returns true
Specifications
Specification | Status | Comment |
---|---|---|
DOM The definition of 'DOMTokenList' in that specification. |
Living Standard | Initial definition |
Browser compatibility
Feature | Chrome | Firefox (Gecko) | Internet Explorer | Opera | Safari (WebKit) |
---|---|---|---|---|---|
Basic support | (Yes) | (Yes) | 10 | (Yes) | ? |
Feature | Android | Android Webview | Firefox Mobile (Gecko) | IE Phone | Opera Mobile | Safari Mobile | Chrome for Android |
---|---|---|---|---|---|---|---|
Basic support | ? | (Yes) | ? | ? | ? | ? | (Yes) |
See Also
DOMSettableTokenList
(object that extends DOMTokenList with settable .value property)
Document Tags and Contributors
Tags:
Contributors to this page:
LouisLazaris,
jpmedley,
cvrebert,
dstereo,
Alhadis,
Sebastianz,
bradleyflood,
teoli,
kscarfone,
Sheppy,
trevorh,
MatrixFrog,
Crash
Last updated by:
LouisLazaris,