DOMTokenList

open class DOMTokenList<T : JsAny> : ListLike<T> (source)

The DOMTokenList interface represents a set of space-separated tokens. Such a set is returned by Element.classList or HTMLLinkElement.relList, and many others.

MDN Reference

Properties

length

open override val length: Int

The read-only length property of the DOMTokenList interface is an integer representing the number of objects stored in the object.

value

var value: T

The value property of the DOMTokenList interface is a stringifier that returns the value of the list serialized as a string, or clears and sets the list to the given value.

Functions

add

fun add(vararg tokens: T)

The add() method of the DOMTokenList interface adds the given tokens to the list, omitting any that are already present.

contains

fun contains(token: T): Boolean

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

entries

open override fun entries(): JsIterator<Tuple2<JsInt, T>>

forEach

open override fun forEach(action: (item: T) -> Unit)

get

open operator fun get(index: Int): T

open operator fun get(key: Symbol.iterator): () -> JsIterator<T>

item

fun item(index: Int): T?

The item() method of the DOMTokenList interface returns an item in the list, determined by its position in the list, its index.

keys

open override fun keys(): JsIterator<JsInt>

remove

fun remove(vararg tokens: T)

The remove() method of the DOMTokenList interface removes the specified tokens from the list.

replace

fun replace(token: T, newToken: T): Boolean

The replace() method of the DOMTokenList interface replaces an existing token with a new token. If the first token doesn't exist, replace() returns false immediately, without adding the new token to the token list.

supports

fun supports(token: T): Boolean

The supports() method of the DOMTokenList interface returns true if a given token is in the associated attribute's supported tokens. This method is intended to support feature detection.

toggle

fun toggle(token: T, force: Boolean = definedExternally): Boolean

The toggle() method of the DOMTokenList interface removes an existing token from the list and returns false. If the token doesn't exist it's added and the function returns true.

values

open override fun values(): JsIterator<T>