DOM: Basic DOM Methods

This page shows commonly used DOM (Document Object Model) methods. Learn to use these methods, and you will know 99% of DOM use.

Get Elements

syntax	meaning
document. getElementById (id)	Return a element object or null. The id should be a string.
document. getElementsByTagName (tag_name)	Return a live HTMLCollection. The tag_name are {"div", "span", "p", …}.
document. getElementsByClassName (class_value)	Return a live HTMLCollection. The class_value should be a string.
document. querySelectorAll (css_selector)	Return a non-live HTMLCollection. The css_selector should be a string of CSS Selector Syntax.

These return array-like object. Some returns a live object, some not.

〔►see DOM: Get Elements by ID, Tag, Name, Class, CSS Selector〕

• 〔►see JS: Array-Like Object〕
• 〔►see DOM: What Does Live Object Mean?〕

Element Attribute

Properties for Working with Element's Attributes

syntax	meaning
node.hasAttribute (attr)	Return true or false. This is especially useful for “boolean attributes” that doesn't have value, such as the attribute checked of input tag for checkboxes.
node.getAttribute (attr)	Return the value of element's attribute attr. If doesn't exist, returns null. The attr is any of {"id", "href", …}. 〔►see DOM: Get Element's Attribute Value〕
node.setAttribute (attr, val)	Set the value of the attribute named attr to value val. If the attribute does not exist, it will be created. 〔►see DOM: Set Element's Attribute Value〕
node.removeAttribute (attr)	Remove the attribute.
node.attributes	Return a live Array-Like Object that are all the attributes. The result object can be indexed by a number of attribute name.

For HTML element's standard attributes, you can use a property directly.

Get/Set Standard Attributes by Properties

syntax	meaning
html_element.attribute_name	Get a element's attribute's value.
html_element.attribute_name = value	Set a element's attribute.

let myHtmlEle = document.getElementsByTagName("a")[0];

myHtmlEle.getAttribute("href");
// is equivalent to
myHtmlEle.href

Using property does not work with XML such as stroke="…" from SVG, or non-standard attributes such as data-xyz="…" from HTML5 Custom Data Attribute.

「class」 Attribute

For the class attribute, there's more convenient methods:

〔►see DOM: List/Add/Remove Class Attribute〕

「style」 Attribute

For the style attribute, there's more convenient properties, but may not work with XML.

syntax	meaning
node.style.css_attribute	get a element's CSS attribute's value.
node.style.css_attribute=value	set a element's CSS attribute.

Example: JS: Change CSS

Get Node {Type, Name, Value}

syntax	meaning
node.nodeType	a integer representing the type of the node node (1 means HTML element, 3 means text node).
node.nodeName	the name of the node node (either the name of tag (For example, P, DIV, SPAN, …) or "#text")
node.nodeValue	the text value of text node or attribute node. Else, null.

〔►see DOM: Node Type, Node Name, Node Value〕

Navigating Nodes

syntax	meaning
node.previousSibling	return null if none.
node.nextSibling	return null if none.
node.firstChild	return null if none.
node.lastChild	return null if none.
node.parentNode	return null if none.

syntax	meaning
node.hasChildNodes()	Return true or false.
node.childNodes	Return read-only live object NodeList. If no child, the object has length 0.
node.children	Return read-only live object HTMLCollection. Value is all non-whitespace children of node.

〔►see DOM: Navigate DOM Tree〕

Creating New Nodes

syntax	meaning
document. createElement (tag_name)	Create a new tag_name element node.
document. createTextNode (str)	Create a new text node with the node value of string str.
node.cloneNode(true)	Return a copy of node, including all child nodes if argument is true.
node.innerHTML	The content of node as string. You can read this value, or set this value to change the node's content. 〔►see DOM: Difference Between textContent, innerHTML, innerText, nodeValue〕

〔►see DOM: Create HTML Element〕

{Insert, Remove, Replace} Nodes

syntax	meaning
node.insertAdjacentElement(position, new_node)	Move new_node to position relative to node. Can insert {before, after} as sibling, or as {first, last} child. 〔►see DOM: .insertAdjacentElement〕

syntax	meaning
p_node.appendChild (new_node)	Move new_node to become last child of p_node, if both nodes are in the same document. Else, just append. It returns the argument new_node. 〔►see JS: .appendChild Example〕
p_node.insertBefore (new_node, nodeX)	Inserts new_node as a new child of p_node before nodeX.
p_node.removeChild (old_node)	Removes the child old_node from p_node.
p_node.replaceChild (new_node, old_node)	Replaces the child node old_node of p_node with new_node. If new_node is in the same doc, it'll also be removed.

Examples:

• DOM: Create HTML Element
• DOM: Remove HTML Element
• DOM: Insert After a Element

Change Element's Text Content

There are 3 ways to change a element's content.

1. Treat it as a innerHTML, and use property innerHTML . This is for HTML (not XML), works in all browsers.
2. Treat it as a text content, and use property textContent . This works well if the content is text and contains no HTML. (if you set value to "<b>bold text</b>", the text won't be bold.)
3. Treat it as a DOM tree node, and use property nodeValue. This is the most general, and works with XML too.

Example: DOM: Change Element's Content

Detail: DOM: Difference Between textContent, innerHTML, innerText, nodeValue

{Add, Remove} Event Handler

syntax	meaning
node.addEventListener (event, ƒ, false)	Add the function ƒ to the event event
node.removeEventListener (event, ƒ …)	Remove the function ƒ that was attached to the event event

〔►see DOM: Add / Remove Event Handler〕

This page was originally based on Christian Heilmann 's blog at http://wait-till-i.com/