React's UI State Model vs Vanilla JavaScript DOM State — A Beginner's Introduction

React

This article is aimed at beginners who've never had the chance to see 'why React'. It takes a very contrived example to make a point about how React's declarative state model could help keep state sanity when code scales.

If you're an experienced developer these series of posts by Steven might give deep insights about why declarative abstractions scale in a way you might not have thought before. Thanks hackernews user Tomuus for the recommendation

When I started my front end journey in 2015, I was privileged enough to have a 6 months training program in which our company at the time — Sapient Nitro ( now Publicis Sapient ) invested in. Our trainer was instructed that by the end of the program we ought to have strong JavaScript fundamentals. I remember one of the SMEs Mahesh, who invested a lot of his time ( and goofy calming laughter ) with us new joinees straight out of college. He guided us to learn DOM JavaScript APIs and make our own jQuery like utility library for the project that we were supposed to deliver in phases during our training.

At that point of time, I wasn't very social and open. I wouldn't talk to any of the SMEs and would just get whatever information I'd get out of limited interaction with other people. But I'm glad that even that had something for me to learn from.

Recently, I have been collaborating with my little brother, who's studying in Canada, in learning web development completely hands on style. So guess what was one of the first things I helped him understand. JavaScript and React both at the same time! Let's walk through what I told him. Ready?

🚀

This is what we are doing to make both in JavaScript and React. Click on the checkbox or the label, it's got a cute little toggling happening.

Let's Start With JavaScript 🔗

We'll have one root html element where we are going to append things

<div id="app"></div>

Let's create a checkbox and set its id attribute

const CHECKBOX_ID = "my-checkbox";

const checkBoxEl = document.createElement("input");
checkBoxEl.type = "checkbox";
checkBoxEl.id = CHECKBOX_ID;

You could also have used setAttribute to set the type and id attributes. We did it in short hand.

Right now the checkBoxEl is a floating in the memory, it's not attached to any DOM node.

Let's create a label the same way we created checkbox

const labelEl = document.createElement("label");

Let's create a text node and append it to the label.

const defaultLabelContent = "Click me to apply fake discount!";
const labelTextNode = document.createTextNode(defaultLabelContent);

labelEl.append(labelTextNode);

Remember, the label and its text node are still in memory because we haven't attached them to a DOM node.

Let's append this the checkbox and label we have made, to our div#app element, so that it actually shows up in the browser.

const appContainerEl = document.getElementById("app");
appContainerEl.append(checkBoxEl);
appContainerEl.append(labelEl);

So far we have:

You would have seen that on websites whenever you click the label of a checkbox, you are able to check and un-check checkbox as if you were clicking on it directly! Let's make that happen now.

labelEl.htmlFor = CHECKBOX_ID; // CHECKBOX_ID is 'my-checkbox'

We tell label element

Hey label! You are linked with the checkbox with id my-checkbox-1

Let's try clicking on the label now and confirm that it checks and unchecks the checkbox.

So far so good?

You'd notice in our original demo that when the checkbox is unchecked we have a text saying You have not availed discount

Let's add that in the same fashion as we've added checkbox and label

const beforeDiscountText = "You have not availed discount";

const discountContentEl = document.createElement("div");
const discountContentTextNode = document.createTextNode(beforeDiscountText);
discountContentEl.append(discountContentTextNode);

appContainerEl.append(discountContentEl);

So far we have:

At this point of time, I want to point your attention to the fact that we are using imperative DOM APIs. What the heck does imperative mean? It means that when we use the APIs that browsers give us, we have to use them and tell the browsers HOW TO DO SOMETHING.

Let's understand imperative vs declarative in layman terms first, with an example borrowed from ui.dev

Imperative Way

emphasises on how to do

You go into a restaurant at the reception and say

I see that table with two chairs, located at the far right corner, which has just emptied. My friend and I am going to walk over there and sit down.

In contrast:

Declarative Way

emphasises on what to do

Table for two, please.

And the receptionist will will take you to the table.

Now let's take a look at why native DOM APIs that we have used are imperative by eavesdropping to this conversation between you and browser APIs:


YOU: Hey Browser! Yeah you! Listen… I want you to make a div for me

createElement API: Okay! Use me and tell me how to do it.

YOU: const divEl = document.createElement('div')

YOU: Okay, hey browser I want to actually show this in-memory div element in the browser. Tell me HOW to do it.

BROWSER: append API will tell you.

append API: Hey! yeah, use me and tell me what to append and how ( you'll get how to do that in my documentation ), and I'll do it for you

YOU: Alright so okay, I already have div with id app in html, so I'll select it using const appEl = document.getElementById('app') and I'll append div element I created before in it by doing appEl.append(divEl)


So when you use browser APIs we have to explicitly use those APIs to tell the browser HOW to do things. This is a very simple example, and already we have a little verbose code:

const CHECKBOX_ID = "my-checkbox";
const defaultLabelContent = "Click me to apply fake discount!";
const beforeDiscountText = "You have not availed discount";

/** Create checkbox */
const checkBoxEl = document.createElement("input");
checkBoxEl.type = "checkbox";
checkBoxEl.id = CHECKBOX_ID;

/** Create label */
const labelEl = document.createElement("label");
const labelTextNode = document.createTextNode(defaultLabelContent);
labelEl.htmlFor = CHECKBOX_ID;
labelEl.append(labelTextNode);

/** Create a dov wotj initial value of the text we have to toggle */
const discountContentEl = document.createElement("div");
const discountContentTextNode = document.createTextNode(beforeDiscountText);
discountContentEl.append(discountContentTextNode);

/** append all the above to our div#app html element */
const appContainerEl = document.getElementById("app");
appContainerEl.append(checkBoxEl);
appContainerEl.append(labelEl);
appContainerEl.append(discountContentEl);

And we are not done yet. We still have to actually toggle the text when checkbox toggles. Let's make that happen. Let's put a change event on checkbox and toggle stuff

// ... the code that we wrote before //

const afterDiscountText = "Discount Availed!";
const afterToggleCheckboxLabelText = 'Click on me to remove fake discount';

/** apply change event listener and pass in a handler function */
checkBoxEl.addEventListener("change", toggleCheckBoxHandler);

function toggleCheckBoxHandler(event) {
  // get hold of the checkbox
  // always safer for browser to tell us
  // on which element it fired the event,
  // instead of us having to pluck out
  // the element from the DOM itself,
  // which might be error prone in a moderately big codebase
  const checkBoxOnWhichChangeHappened = event.target;

  // we check the actual `checked` value of the checkbox DOM Element
  // if it's true we change two things
  // 1. the discount text
  // 2. the label text of checkbox
  if (checkBoxOnWhichChangeHappened.checked) {
    discountContentTextNode.textContent = afterDiscountText;
    labelTextNode.textContent = afterToggleCheckboxLabelText
  } else {
    // if checkbox is not checked, we restore the values
    // to the old ( initial ones )
    discountContentTextNode.textContent = beforeDiscountText;
    labelTextNode.textContent = defaultLabelContent
  }
}

We are done! Let's see it in action

Feeling nice having gotten this far isn't it? Good reading!

I want to emphasize again on the fact of how we wrote the toggle logic. We've to manually check for a lot of things and actually reach out inside the DOM

  1. To check if the the checkbox is checked or un-checked
  2. To manually select the text nodes whose content has to be changed and manually change them depending on the state of the DOM itself! ( the checkbox check state )

That's a considerable amount of things you have to tell the browser HOW to do

I remember writing assembly code for my microprocessor class in 3rd year of college — explicitly telling which register should hold what value and what operation should be performed when, to achieve a particular result explicitly and imperatively. That's how trying to change DOM values through vanilla JavaScript APIs feels like. It's not bad, it's actually really powerful in a way if you want to make website. But to be able to make app like features and interactions with these APIs usually result in developers making abstractions on top of these APIs.

One such, one of the most popular abstractions over DOM APIs is jQuery. Some reasons why developers chose it at the time was because

  1. It's very heavily tested
  2. It made up for browser quirks, which at that time was urgently needed.

But it still deals with us keeping the UI state in the DOM itself ( like we did when we checked if checkbox was checked or not by actually reading its value from the checkbox element ).

Let's now see how React's declarative state and element modeling helps to mitigate verboseness.

import React, { useState } from "react";
import ReactDOM from "react-dom";

const CHECKBOX_ID = "my-checkbox";
const defaultLabelContent = "Toggle me, you newbies";
const beforeDiscountText = "You have not availabled discount";
const afterDiscountText = "Discount Availed!";
const beforeLabelText = "Click me to apply fake discount!"
const afterLabelText = "Click on me to remove fake discount"

export default function App() {
  const [isChecked, setIsChecked] = useState(false);

  function handleChange() {
    setIsChecked((prevState) => !prevState);
  }

  const discountText = isChecked
    ? afterDiscountText
    : beforeDiscountText;

  const labelText = isChecked
    ? afterLabelText
    : beforeLabelText

  return (
    <>
      <input
        checked={isChecked}
        type="checkbox"
        id={CHECKBOX_ID}
        onChange={handleChange}
      />

      <label htmlFor={CHECKBOX_ID}>
        {labelText}
      </label>

      <div>{discountText}</div>
    </>
  );
}

const rootElement = document.getElementById("root");

ReactDOM.render(
  <App />,
  rootElement
);

Instead of storing the checkbox close and open state in DOM itself and reading it by reaching out into the DOM element, we are using React's state model to store that value. Think of it as a fish rod. Instead of having to go inside the water and catching the fish with your hand, you can now do that with your fish rod while sitting in your boat.

Instead of handling change on checkbox like this:

function toggleCheckBoxHandler(event) {
  const checkBoxOnWhichChangeHappened = event.target;

  if (checkBoxOnWhichChangeHappened.checked) {
    discountContentTextNode.textContent = afterDiscountText;
    labelTextNode.textContent = 'Click on me to remove fake discount'
  } else {
    discountContentTextNode.textContent = beforeDiscountText;
    labelTextNode.textContent = defaultLabelContent
  }
}

We're just toggling React state

function handleChange() {
  setIsChecked((prevState) => !prevState);
}

and giving that state to the checkbox, so that it obeys whatever React state tells it do

<input
  checked={isChecked}
  type="checkbox"
  id={CHECKBOX_ID}
  onChange={handleChange}
/>

since React re renders the component when any of its state variables change, we can depend on the value of isChecked state to show something different when checkbox is checked

const discountText = isChecked
  ? afterDiscountText
  : beforeDiscountText;

const labelText = isChecked
  ? afterLabelText
  : beforeLabelText
<label htmlFor={CHECKBOX_ID}>
  {labelText}
</label>

<div>{discountText}</div>

with the help of React we are telling WHAT we want. We want a state called isChecked which should toggle when change event listener fires for checkbox. And React is doing its reconciliation magic to commit the changes to DOM for us, so that we don't have to do it manually, and only the elements which are dependent on the changed state actually change in the DOM.

That's why React as an abstraction to write UIs enable us to tell WHAT to do, instead of HOW.

Hope that if you are new to React, this write up gave a glimpse of one of the reasons why writing UI in React helps us wrap our head around of the UI State much easily than what is possible when we only use vanilla JavaScript.


If you enjoyed this article please consider subscribing to my tech newsletter.

Mastodon