Interface DOMTokenList

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

interface DOMTokenList {
    length: number;
    value: string;
    add(...tokens): void;
    contains(token): boolean;
    forEach(callbackfn, thisArg?): void;
    item(index): string;
    remove(...tokens): void;
    replace(token, newToken): boolean;
    supports(token): boolean;
    toString(): string;
    toggle(token, force?): boolean;
    [index: number]: string;
}

Indexable

[index: number]: string

Properties

length value

Methods

add contains forEach item remove replace supports toString toggle

Properties

Readonly length

length: number

Returns the number of tokens.

MDN Reference

value

value: string

Returns the associated set as string.

Can be set, to change the associated attribute.

MDN Reference

Methods

add

  • add(...tokens): void

  • Adds all arguments passed, except those already present.

    Throws a "SyntaxError" DOMException if one of the arguments is the empty string.

    Throws an "InvalidCharacterError" DOMException if one of the arguments contains any ASCII whitespace.

    MDN Reference

    Parameters

    • Rest ...tokens: string[]

    Returns void

contains

  • contains(token): boolean

  • Returns true if token is present, and false otherwise.

    MDN Reference

    Parameters

    • token: string

    Returns boolean

forEach

  • forEach(callbackfn, thisArg?): void

  • Parameters

    • callbackfn: Object
    • Optional thisArg: any

    Returns void

item

  • item(index): string

  • Returns the token with index index.

    MDN Reference

    Parameters

    • index: number

    Returns string

remove

  • remove(...tokens): void

  • Removes arguments passed, if they are present.

    Throws a "SyntaxError" DOMException if one of the arguments is the empty string.

    Throws an "InvalidCharacterError" DOMException if one of the arguments contains any ASCII whitespace.

    MDN Reference

    Parameters

    • Rest ...tokens: string[]

    Returns void

replace

  • replace(token, newToken): boolean

  • Replaces token with newToken.

    Returns true if token was replaced with newToken, and false otherwise.

    Throws a "SyntaxError" DOMException if one of the arguments is the empty string.

    Throws an "InvalidCharacterError" DOMException if one of the arguments contains any ASCII whitespace.

    MDN Reference

    Parameters

    • token: string
    • newToken: string

    Returns boolean

supports

  • supports(token): boolean

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

    Throws a TypeError if the associated attribute has no supported tokens defined.

    MDN Reference

    Parameters

    • token: string

    Returns boolean

toString

  • toString(): string

  • Returns string

toggle

  • toggle(token, force?): 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()).

    Returns true if token is now present, and false otherwise.

    Throws a "SyntaxError" DOMException if token is empty.

    Throws an "InvalidCharacterError" DOMException if token contains any spaces.

    MDN Reference

    Parameters

    • token: string
    • Optional force: boolean

    Returns boolean

Settings

Member Visibility

Theme

On This Page

lengthvalueaddcontainsforEachitemremovereplacesupportstoStringtoggle