ClassList

Extends: DOMTokenList

Category: browser

See: https://dom.spec.whatwg.org/#dom-element-classlist

• ClassList

  • new ClassList()

  • instance

    • .value : string
    • .length
    • .add(...tokens)
    • .remove(...tokens)
    • .replace(oldToken, newToken)
    • .toggle(token, force)
    • .item(index)
    • .contains(token)
    • .supports(token)

  • static

    • .ClassList
      • new ClassList(node)

new ClassList()

Implements classlist

classList.value : string

Overrides: value

classList.length

Returns the number of tokens in the list

Read only

See: https://dom.spec.whatwg.org/#dom-domtokenlist-length

classList.add(...tokens)

Adds the specified tokens to the token list. If the token is already present, no error is thrown.

Throws:

• DOMException

See: https://dom.spec.whatwg.org/#dom-domtokenlist-add

classList.remove(...tokens)

Removes the specified items from the token list. If the token is not present, no error is thrown.

Throws:

• DOMException

See: https://dom.spec.whatwg.org/#dom-domtokenlist-remove

classList.replace(oldToken, newToken)

Replaces an old token with a new token. If the old token doesn't exist, no action occurs, and false is returned.

Throws:

• DOMException

See: https://dom.spec.whatwg.org/#dom-domtokenlist-replace

classList.toggle(token, force)

Toggles a token within the list. If force is not present, then the following rules are applied:

• if the token is present, it is removed, and false is returned
• if the token isn't present, it is added, and true is returned

If force is supplied, then:

• if true, the token is added
• if false, the token is removed

Returns: boolean - if the token exists in the last after the operation

Throws:

• DOMException

See: https://dom.spec.whatwg.org/#dom-domtokenlist-toggle

classList.item(index)

Return the item at the specified index, or null if the index is out-of-range

Returns: string - the item at the index, or null if index is out of range

Throws:

• DOMException

See: https://dom.spec.whatwg.org/#dom-domtokenlist-item

classList.contains(token)

Returns whether the token is in the list or not.

Returns: boolean - if true, the token is in the list, otherwise it isn't

Throws:

• DOMException

See: https://dom.spec.whatwg.org/#dom-domtokenlist-contains

classList.supports(token)

Returns true if the token is acceptable to the list; otherwise returns false. If false is returned, passing the token would throw an error when calling any other method.

Returns: boolean - if true, the token is acceptable when calling other methods

See: https://dom.spec.whatwg.org/#dom-domtokenlist-supports

ClassList.ClassList

new ClassList(node)

Creates an instance of ClassList.