DOMTokenList

external class DOMTokenList : ListLike<String> (source)

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

MDN Reference

Properties

length

open override val length: Int

Returns the number of tokens.

value

var value: String

Returns the associated set as string.

Functions

add

fun add(vararg tokens: String)

Adds all arguments passed, except those already present.

contains

fun contains(token: String): Boolean

Returns true if token is present, and false otherwise.

entries

open override fun entries(): JsIterator<JsTuple2<Int, String>>

forEach

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

get

open operator fun get(index: Int): String

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

item

fun item(index: Int): String?

Returns the token with index index.

iterator

open inline operator fun iterator(): Iterator<String>

keys

open override fun keys(): JsIterator<Int>

remove

fun remove(vararg tokens: String)

Removes arguments passed, if they are present.

replace

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

Replaces token with newToken.

supports

fun supports(token: String): Boolean

Returns true if token is in the associated attribute's supported tokens. Returns false otherwise.

toggle

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

If force is not given, "toggles" token, removing it if it's present and adding it if it's not present. If force is true, adds token (same as add()). If force is false, removes token (same as remove()).

values

open override fun values(): JsIterator<String>