{ "componentChunkName": "component---src-templates-blog-post-tsx", "path": "/blog/2018-11-06-build-a-family-tree-maker-using-react-hooks-and-microstates/", "result": {"data":{"blogPost":{"title":"Build a Family Tree maker using React Hooks and Microstates","slug":"/blog/2018-11-06-build-a-family-tree-maker-using-react-hooks-and-microstates/","authorNodes":[{"name":"Taras Mankovski","slug":"/people/taras-mankovski/"}],"markdown":{"html":"

Demo of Family Builder Component

\n

In this tutorial, we will create a Family Tree marker component using React Hooks and Microstates. The Family Tree maker will allow the user to enter their name, then their parent’s names, their parent’s parent’s names and their parent’s parent’s parent’s names, as far back as they can remember.

\n

To do this, we’ll follow the following steps:

\n
    \n
  1. Create a new project and install Microstates
    2. \n
  2. Build recursive Family Tree maker component
    3. \n
  3. Persist component state in LocalStorage
    4. \n
  4. Optimize re-rendering of our component
    5. \n
\n

Let’s get started.

\n

Create a new project and install Microstates

\n

Let’s create a new app using create-react-app. If you don’t have create-react-app installed, you can install it by following instructions on create-react-app website.

\n
create-react-app family-tree-app\ncd family-tree-app # go into created directory
\n

Then add @microstates/react & microstates to your project.

\n
npm install --save microstates @microstates/react
\n

You should be able to start the server using npm start and see the React logo when you go to http://localhost:3000/.

\n

Build recursive Family Tree builder component

\n

Demo of Family Builder Component

\n

Our component will allow the user to enter their name. When the name is entered, they’ll see an input field to enter names of their mother and father. When a parent’s name is entered, we’ll show input fields for parent’s parents. This will work recursively as deeply as the user has patience to enter.

\n

State management is usually the most difficult part of building this kind of component. Luckily, Microstates will make this very easy. All we need to do is create a type that will allow us to store a name for a person, a mother and a father with their names. It needs to be recursive, just like our component. Microstates makes it very easy.

\n
class Person {\n  name = String; // name of the person \n  mother = Person; // mother is of type Person\n  father = Person; // father is of type Person\n}
\n

Our type is complete. This is everything that we need to create a recursive data structure. Microstates will take care of proving us with transitions and handle the immutability of this recursive data structure. Now, we just need to write the component that will use our Person type and useType hook. Let’s begin by creating the state and passing it to our future FamilyTree component.

\n
import useType from '@microstates/react';\n\nfunction App() {\n  let person = useType(Person);\n  return <FamilyTree person={person} />;\n}
\n

We need to actually write our FamilyTree component. The component is going to show an input field for the name. When the name is not empty the component will render a FamilyTree component for the mother and the father.

\n
function FamilyTree({ person )} {\n\treturn (\n\t\t<>\n        <input\n          value={person.name.state}\n          onChange={e => person.name.set(e.target.value)}\n        />\n        {person.name.state !== \"\" && (\n\t\t\t<>\n\t\t\t\tFather: <FamilyTree person={person.father} />\n\t\t\t\t<br>\n\t\t\t\tMother: <FamilyTree person={person.mother} />\n\t\t\t</>\n        )}\n      </>\n\t)\n}
\n

That should do it. Look at the onChange handler of the input. Notice the person.name.set() transition. It’s similar to a reducer that changes the name of the node, but Microstates handles immutably updating the value and causing our component to update via our useType hook. Let’s use another hook to persist our input in LocalStorage.

\n

Persist component state in localStorage

\n

Every transition creates a new value that we can serialize and later use to restore the state. We can use this to persist the state in LocalStorage. When the user refreshes their page, the family tree will be restored from LocalStorage. To do this, we’ll need to change a few things.

\n
    \n
  1. Restore state from localStorage
    2. \n
  2. Create the microstate with restored state
    3. \n
  3. Persist the state in localStorage
    4. \n
\n

Restore state from localStorage

\n

When the component is being rendered, we need to grab a key from localStorage and parse it with JSON.parse. This part is not unique to React Hooks or Microstates.

\n
const initial = JSON.parse(localStorage.getItem(\"family-tree\") || \"{}\");
\n

Notice the string wrapping an object ”{}\" That’s an empty object that was serialized. I’m using this to ensure that there will be a value even when localStorage doesn’t have anything. This will happen on first rendering the component.

\n

Create the microstate with restored state

\n

Once we have the initial state from localStorage, we can pass it to our App component and create the microstate with the passed in value.

\n
const initial = JSON.parse(localStorage.getItem(\"family-tree\") || \"{}\");\n\nfunction App({ initial }) {\n  let person = useType(Person, initial);\n\n  return <FamilyTree person={person} />;\n}\n\nReactDOM.render(<App initial={initial} />, document.getElementById(\"root\"));
\n

This will allow us to deserialize the value, but what about saving the value into localStorage? We’ll do that next, it’ll require that we use another hook.

\n

Persist the state in localStorage

\n

We want the state of the family tree to be saved in localStorage. To do this, we need to extract serializable state from the microstate. We can use valueOf function to get a value that we can store in localStorage.

\n
import { valueOf } from \"microstates\";\n\nfunction App({ initial }) {\n  let person = useType(Person, initial);\n\n  let value = valueOf(person);\n\n  return <FamilyTree person={person} />;\n}
\n

Once we have the value from the microstate, we can use useEffect hook to queue up the localStorage.setItem operation. useEffect hook is executed after the render is complete, which allows you to perform potentially slow operation without slowing down rendering. It also allows you to prevent unnecessary invocations of this effect by declaring the value as a dependant value. Here is what that looks like,

\n
import React, { useEffect } from \"react\";\nimport { valueOf } from \"microstates\";\n\nfunction App({ initial }) {\n  let person = useType(Person, initial);\n\n  let value = valueOf(person);\n\n  useEffect(\n    () => {\n      let serialized = JSON.stringify(value);\n      localStorage.setItem(\"family-tree\", serialized);\n    },\n    [value]\n  );\n\n  return <FamilyTree person={person} />;\n}
\n

In this section, we added the ability to store user’s input in localStorage to allow us to restore their input when the user returns to the page. We used valueOf to extract value from the microstate and useEffect hook to ensure that calling our persist operation does not block rendering. In the last part of this tutorial, we’ll optimize the component to ensure that it doesn’t re-renders parts of the tree where state did not change.

\n

Optimize re-rendering of our component

\n

It’s not unusual for performance improvements to be left until the end of the project, but unusual for performance tweaking to be easy. Fortunately, Microstates was designed in a way that makes optimizing performance with React easy. In this section, I’ll show you how to optimize the component to ensure that only parts that changed actually re-render.

\n

The key to optimizing React rendering is to ensure that only components that changed get re-rendered. React Devtools has a feature called “Highlight Updates” that makes it easy to see which components get re-rendered when you interact with the application.

\n

Demo of Family Builder Component before optimization

\n

When “Highlight Updates” is turned on, the DevTools will highlight areas of the component tree that are being updated. If you look at the example above, you can see that every keystroke causes every component to re-render. This is a lot of unnecessary re-renders.

\n

What we need to do is to only re-render children when the state of children has changed. We can use the fact that Microstates are immutable as a guarantee that microstates will only change their references when their value has changed. If they value did not change, then the same microstate will be reused.

\n

We can combine this reference guarantee with the useMemo hook to memoize components based on the microstate that they consume. This will ensure that memoization will be invalidated when the dependant microstate changes. Let’s modify our component to memoize parent’s components based on their microstates.

\n
function FamilyTree({ person }) {\n  const father = useMemo(() => <FamilyTree person={person.father} />, [\n    person.father\n  ]);\n\n  const mother = useMemo(() => <FamilyTree person={person.mother} />, [\n    person.mother\n  ]);\n\n  return (\n    <>\n      <input\n        value={person.name.state}\n        onChange={e => person.name.set(e.target.value)}\n      />\n      {person.name.state && (\n        <ul>\n          <li>Father: {father}</li>\n          <li>Mother: {mother}</li>\n        </ul>\n      )}\n    </>\n  );\n}
\n

After we make this change, we can check the result and see if we made an improvement. Now when you edit an input field, it’s only changing components above the component that you edited because their microstates were changed.

\n

Demo of Family Builder Components after optimizations

\n

It’s worth noting that we only change the input in one component but all of the parent components are marked as changing. This is because when a nested microstate changes, the parents of that microstate have to be re-created as per rules of immutability.

\n

Conclusion

\n

In this tutorial, use used useType hoook to create a recursive component using Microstates, stored our state in localStorage and optimize re-rendering of our components.

\n

If you thought that this was easy, then consider how much we were able to do with Microsates and React in 80 lines of code. You can see the final result in GitHub Repo and CodeSandbox.

\n

If you thought this was difficult, please file an issue and describe what you found difficult.

\n

Regardless, tweet me @tarasm and let me know what you think about Microstates and useType hook. If you’re looking for help building large applications, consider hiring Frontside to help you build your app.

","frontmatter":{"date":"November 06, 2018","description":"If you use React, you probably know about the React Hooks RFC that was introduced at ReactConf. It’s an exciting proposal because it promises to bring the power of class components to function components. It also a convention for creating React extensions that feel like first-class APIs in the React ecosystem. React Hooks API and Microstates bring expressiveness of React function components to a whole new level. ","tags":["javascript","microstates","react"],"img":{"childImageSharp":{"fixed":{"src":"/static/7e5c20fcd943e76e94d77a4566eaa74d/a7715/2018-06-14-what-is-new-in-wcag-2-1_wcag-2-1-image.jpg"}}}}}}},"pageContext":{"id":"9c42e6d7-fc4e-55f5-9bd3-1411d87bee14"}}, "staticQueryHashes": ["1241260443"]}