"innerHTML += ..." vs "appendChild(txtNode)"

JavascriptDom

Javascript Problem Overview


The question is, comparing concatination using innerHTML and appending a text node to an existing node. What is happening behind the scene?

My thoughts around this so far:

  • I'm guessing both are causing a 'ReFlow'.
  • The latter (appending a text node), from what I know, also causes a complete rebuild of the DOM (correct? Are they both doing this?).
  • The former seems to have some other nasty side effects, like causing previously saved references to child nodes to the node I'm modifying innerHTML, to no longer point to 'the current DOM'/'correct version of the child node'. In contrast, when appending children, references seem to stay intact. Why is this?

I'm hoping you people can clear this up for me, thanks!

Javascript Solutions


Solution 1 - Javascript

The latter (appendChild) does not cause a complete rebuild of the DOM or even all of the elements/nodes within the target.

The former (setting innerHTML) does cause a complete rebuild of the content of the target element, which if you're appending is unnecessary.

Appending via innerHTML += content makes the browser run through all of the nodes in the element building an HTML string to give to the JavaScript layer. Your code then appends text to it and sets innerHTML, causing the browser to drop all of the old nodes in the target, re-parse all of that HTML, and build new nodes. So in that sense, it may not be efficient. (However, parsing HTML is what browsers do and they're really, really fast at it.)

Setting innerHTML does indeed invalidate any references to elements within the target element you may be holding -- because those elements don't exist anymore, you removed them and then put in new ones (that look very similar) when you set innerHTML.

In short, if you're appending, I'd use appendChild (or insertAdjacentHTML, see below). If you're replacing, there are very valid situations where using innerHTML is a better option than creating the tree yourself via the DOM API (speed being chief amongst them).

Finally, it's worth mentioning a couple of other alternatives:

  • append is a relatively recent addition to the DOM (but has excellent support other than truly obsolete browsers). It appends one or more items to the element, where the items can be nodes, elements, or HTML strings defining nodes and elements. Unlike appendChild, it supports HTML strings as well as nodes, and alsos supports multiple arguments. For your use case, it's less cumbersome than the next option in this list: parent.append(htmlString).

  • insertAdjacentHTML inserts nodes and elements you supply as an HTML string into or next to an element. You can append to an element with it: theElement.insertAdjacentHTML("beforeend", "the HTML goes here"); The first argument is where to put the HTML; your choices are:

    • "beforebegin" (outside the element, just in front of it)
    • "afterbegin" (inside the element, at the beginning)
    • "beforeend" (inside the element, at the end)
    • "afterend" (outside the element, just in after it) Note that "afterbegin" and "beforeend" insert into the element itself, whereas "beforebegin" and "afterend" insert into the element's parent. Browser support is basically universal.
  • insertAdjacentText is just like insertAdjacentHTML except that it inserts a text node (the text is not treated as HTML). Browser support is basically universal.

Solution 2 - Javascript

I've created a small gist with a performance comparison between innerHTML and appendChild.

The last one wins by a wide margin

https://gist.github.com/oliverfernandez/5619180

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
Questionuser54808View Question on Stackoverflow
Solution 1 - JavascriptT.J. CrowderView Answer on Stackoverflow
Solution 2 - JavascriptolifernaView Answer on Stackoverflow