Javascript classList

CSS Klassen hinzufügen, entfernen und prüfen, ob ein Element zu einer CSS-Klasse gehört

classList fügt einem Element CSS-Klassen mit add, remove, toggle so einfach zu wie mit jQuery hinzu und entfernt sie ebenso einfach wieder. classList.contains testet, ob ein Element eine Klasse enthält.

Vor HTML5 war das class-Attribut eine Qual für Javascript. Wir können zwar beliebig viele Klassen in einem class-Attribut unterbringen, aber der Zugriff auf class war mit der heißen Nadel gestrickt und ging immer davon aus, dass es nur einen Wert für das class-Attribut gibt.

Die DOM-Spezifikation verliert gerade mal einen Satz zu classList. Ich habe das Gefühl, das W3C schämt sich, dass classList erst 10 Years After dabei ist.

classList Methoden

Wenn jQuery sowieso geladen wird, ist classList kein Thema, aber für einfache Manipulationen erspart classList das Einbinden von jQuery.

classList wird von allen modernen Browsern (IE ab Version 10) unterstützt. Wenn IE9 unterstützt werden muss, hilft ein Polyfill: eligray classList.js.

  • classList.add ()

    fügt der classList eine neue Klasse hinzu

  • classList.remove ()

    entfernt eine Klasse aus der classList, ohne die übrigen Klassen zu beeinflussen.

  • classList.contains ()

    prüft, ob eine Klasse in der classList liegt

  • classList.toggle ()

    toggelt eine Klasse in die classList bzw. hinaus. Beim ersten Aufruf wird die Klasse eingeschaltet, beim zweiten Aufruf wird die Klasse entfernt.

  • classList.item ()

    gibt die Klasse an der angegebenen Position innerhalb der Liste zurück

  • classList.toString ()

    wandelt die Liste in einen String um

  • classList.length

    gibt die Zahl der Klassen in der classList an

  • classList.value

    fügt dem classList-Objekt eigene Eigenschaft und Methoden hinzu

classList iterieren / durchlaufen

Die classList eines Elements kann iteriert / durchlaufen werden.

for (let name of document.querySelector(".nodelist").classList) {
	console.log (name);
}

liefert

[Log] nodelist (classlist.html, line 321)
[Log] fruits (classlist.html, line 321)
[Log] gallery (classlist.html, line 321)
[Log] nocaption (classlist.html, line 321)

classList toggle

classList toggle () ist wie geschaffen für das »slidedown« und »slideup« in den responsiven Menüs der mobilen Geräte.

Das Beispiel nutzt CSS transition für den slide-Effekt.

  • classList.add()
  • classList.contains()
  • classList.item()
  • classList.length
  • classList.remove()
  • classList.toggle
.toggle { 
    transition: height 1s ease-in-out; 
    height: 0px; overflow:hidden;
}
.slowdown { height: 160px }

Das Icon ist eine SVG-Grafik, class toggle ist eine HTML-Liste

<div class="icon">
    <svg  width="100" height="60" viewBox="0 0 600 240">…</svg>
</div>

<ul class="toggle">
    <li>classList.add()</li>
    <li>classList.contains()</li>
	…
</ul>

Zum Toggeln mit Javascript classList reichen ein paar Zeilen Code:

Toggeln mit Javascript classList
<script>
let icon = document.querySelector('.icon');
icon.addEventListener('click', function () {
    document.querySelector('.toggle').classList.toggle('slowdown');
});
</script>

elem . classList . contains

jQuery hat die wunderbare Methode hasClass. Mit purem Javascript (Vanilla) war der Test, ob ein Element eine bestimmte Klasse aufweist, immer Würfeln ohne Sechser.

contains () gibt true oder false zurück, je nachdem, ob die Klasse in der Liste der Klassen des Elements enthalten ist oder nicht.

<img id="elem" class="bird1 bird2 bird3" … />
…
if (elem.classList.contains('bird1')) {
}

matches

matches () liefert ebenfalls einen Test, ob ein Element eine bestimmte Klasse enthält.

if (elem.matches(".myclass")) {
  // mach was
}

IE 11 Support mit -ms-

classList.item

elem.classList.item() gibt den Namen der Klasse an einer Position zurück. classList.item() ist kein Array, also keine eckigen Klammern!


Mehrere Klassen

In jQuery fügt $(elem).addClass("first second third") einem Element gleich mehrere Klassen hinzu; mit classList ist die Syntax ähnlich, aber die einzelnen Klassen müssen in Hochkommas und von Kommas getrennt geschrieben werden.

Javascript classList mehrere Klassen

Der Aufruf

console.log (document.querySelector('#b2').classList);

liefert

DOMTokenList
0: "bird1"
1: "bird2"
2: "bird3"
constructor: DOMTokenListConstructor
length: 3

classList vs className

Vor classList gab es bereits className. Der Aufruf von elem.className ersetzt den kompletten String des class-Attributs. Wenn also bereits CSS-Klassen vorhanden sind, löscht classList alles.

document.getElementsByTagName('tr')[i].className = 'newclass';

className setzt und liest den Namen der Klassen eines Elements, aber className liefert die Namen der Klassen in einem String, getrennt durch Leerzeichen. Damit kann man arbeiten, aber nicht so komfortabel wie mit classList.

<div id="look" class="foo bar nos">
…
</div>

console.log (look.className) zeigt



	

Eine Klasse mit className hinzufügen:

look.className = look.className + " more";

Testen, ob look die Klasse bar enthält:

if (/bar/.test(look.className) === true) console.log ("contains");

oder auf classname testen mit search

let result = classes.search("bar");

Gibt "4" zurück, weil 4 der Startindex von bar im className-String ist.

Browser-Unterstützung für classList

classList wird von allen modernen Browser unterstützt. Internet Explorer ab Version 10, aber für IE9 gibt es ein Polyfil für classList bei github

IE11 unterstützt zwar classList, allerdings nicht auf SVG-Elementen. Der Fehler ist zwar als "fixed" gekennzeichnet, ist aber erst in Microsoft Edge gefixed.

{ } { } { }