The getElementsByClassName
method of Document
interface returns an array-like object of all child elements which have all of the given class name(s).
When called on the document
object, the complete document is searched, including the root node. You may also call getElementsByClassName()
on any element; it will return only elements which are descendants of the specified root element with the given class name(s).
Warning: This is a live HTMLCollection
. Changes in the DOM will reflect in the array as the changes occur. If an element selected by this array no longer qualifies for the selector, it will automatically be removed. Be aware of this for iteration purposes.
getElementsByClassName(names)
A live HTMLCollection
of found elements.
Get all elements that have a class of 'test':
document.getElementsByClassName("test");
Get all elements that have both the 'red' and 'test' classes:
document.getElementsByClassName("red test");
Get all elements that have a class of 'test', inside of an element that has the ID of 'main':
document.getElementById("main").getElementsByClassName("test");
Get the first element with a class of 'test', or undefined
if there is no matching element:
document.getElementsByClassName("test")[0];
We can also use methods of Array.prototype on any HTMLCollection
by passing the HTMLCollection
as the method's this value. Here we'll find all div elements that have a class of 'test':
const testElements = document.getElementsByClassName("test");
const testDivs = Array.prototype.filter.call(
testElements,
(testElement) => testElement.nodeName === "DIV",
);
This is the most commonly used method of operation.
<html lang="en">
<body>
<div id="parent-id">
<p>hello world 1</p>
<p class="test">hello world 2</p>
<p>hello world 3</p>
<p>hello world 4</p>
</div>
<script>
const parentDOM = document.getElementById("parent-id");
const test = parentDOM.getElementsByClassName("test");
console.log(test);
const testTarget = parentDOM.getElementsByClassName("test")[0];
console.log(testTarget);
</script>
</body>
</html>
document.getElementsByClassName
works very similarly to document.querySelector
and document.querySelectorAll
. Only elements with ALL of the classNames specified are selected.
HTML
<span class="orange fruit">Orange Fruit</span>
<span class="orange juice">Orange Juice</span>
<span class="apple juice">Apple Juice</span>
<span class="foo bar">Something Random</span>
<textarea id="resultArea" style="width:98%;height:7em"></textarea>
JavaScript
const allOrangeJuiceByClass = document.getElementsByClassName("orange juice");
let result = "document.getElementsByClassName('orange juice')";
for (let i = 0; i < allOrangeJuiceByClass.length; i++) {
result += `\n ${allOrangeJuiceByClass[i].textContent}`;
}
const allOrangeJuiceQuery = document.querySelectorAll(".orange.juice");
result += "\n\ndocument.querySelectorAll('.orange.juice')";
for (let i = 0; i < allOrangeJuiceQuery.length; i++) {
result += `\n ${allOrangeJuiceQuery[i].textContent}`;
}
document.getElementById("resultArea").value = result;
Result