How to useRef to fix React performance issues
Tags: javascript, react, performance, tutorial
Published: 2020-11-24 00:59:18

### And how we stopped our React Context re-rendering everything

Refs are a seldom-used feature in React. If you’ve read the [official React guide](https://reactjs.org/docs/refs-and-the-dom.html), they’re introduced as an “escape hatch” out of the typical React data flow, with a warning to use them sparingly, and they’re primarily billed as the correct way to access a component’s underlying DOM element.

But alongside the concept of Hooks, the React team introduced the [`useRef`](https://reactjs.org/docs/hooks-reference.html#useref) Hook, which extends this functionality:

> `useRef()` is useful for more than the `ref` attribute. It’s [handy for keeping any mutable value around](https://reactjs.org/docs/hooks-faq.html#is-there-something-like-instance-variables) similar to how you’d use instance fields in classes.

While I overlooked this point when the new Hook APIs launched, it proved to be surprisingly useful.

👉 [Click here to skip to the solution and code snippets](#the-solution)

## The Problem

I’m a software engineer working on [Rowy](https://rowy.io/?utm_source=dev.to&utm_medium=blog&utm_campaign=How%20to%20useRef%20to%20Fix%20React%20Performance%20Issues), an open-source React app that combines a spreadsheet UI with the full power of Firestore and Firebase. One of its key features is the **side drawer**, a form-like UI to edit a single row, that slides over the main table.

![Screen recording of a user selecting a cell and opening the side drawer](https://dev-to-uploads.s3.amazonaws.com/i/j0revf9wzbzehbcvvc40.gif)

When the user clicks on a cell in the table, the side drawer can be opened to edit that cell’s corresponding row. In other words, what we render in the side drawer is dependent on the currently selected row — this should be stored in state.

The most logical place to put this state is within the side drawer component itself because when the user selects a different cell, it should _only_ affect the side drawer. However:

- We need to _set_ this state from the table component. We’re using [`react-data-grid`](https://github.com/adazzle/react-data-grid) to render the table itself, and it accepts a callback prop that’s called whenever the user selects a cell. Currently, it’s the only way to respond to that event.

- But the side drawer and table components are siblings, so they can’t directly access each other’s state.

React’s recommendation is to [lift this state](https://reactjs.org/docs/lifting-state-up.html) to the components’ closest common ancestor, in this case, `TablePage`. But we decided against moving the state here because:

1. `TablePage` didn’t contain any state and was primarily a container for the table and side drawer components, neither of which received any props. We preferred to keep it this way.

2. We were already sharing a lot of “global” data via a [context](https://reactjs.org/docs/context.html) located close to the root of the component tree, and we felt it made sense to add this state to that central data store.

<aside><small><i>Side note: even if we put the state in <code>TablePage</code>, we would have run into the same problem below anyway.</i></small></aside>

The problem was whenever the user selected a cell or opened the side drawer, the update to this global context would cause **the entire app to re-render**. This included the main table component, which could have dozens of cells displayed at a time, each with its own editor component. This would result in a render time of around **650 ms**(!), long enough to see a visible delay in the side drawer’s open animation.

<figure>

![Screen recording of delay in side drawer open animation](https://dev-to-uploads.s3.amazonaws.com/i/rfq9p10yml5smp2fr34n.gif)

<figcaption>Notice the delay between clicking the open button and when the side drawer animates to open</figcaption>

</figure>

The reason behind this is a key feature of context — the very reason why it’s better to use in React as opposed to global JavaScript variables:

> All consumers that are descendants of a Provider will re-render whenever the Provider’s `value` prop changes.

While this Hook into React’s state and lifecycle has served us well so far, it seems we had now shot ourselves in the foot.

## The Aha Moment

We first explored a few different solutions (from [Dan Abramov’s post](https://github.com/facebook/react/issues/15156#issuecomment-474590693) on the issue) before settling on `useRef`:

1. **Split the context, i.e. create a new `SideDrawerContext`.**
  The table would still need to consume the new context, which still updates when the side drawer opens, [causing the table to re-render](https://reactjs.org/docs/hooks-reference.html#usecontext) unnecessarily.

2. **Wrap the table component in `React.memo` or `useMemo`.**
  The table would still need to call `useContext` to access the side drawer’s state and [neither API prevents it from causing re-renders](https://reactjs.org/docs/react-api.html#reactmemo).

3. **Memoize the `react-data-grid` component used to render the table.**
  This would have introduced more verbosity to our code. We also found it prevented _necessary_ re-renders, requiring us to spend more time fixing or restructuring our code entirely, solely to implement the side drawer.

While reading through the Hook APIs and `useMemo` a few more times, I finally came across that point about `useRef`:

> `useRef()` is useful for more than the `ref` attribute. It’s [handy for keeping any mutable value around](https://reactjs.org/docs/hooks-faq.html#is-there-something-like-instance-variables) similar to how you’d use instance fields in classes.

And more importantly:

> `useRef` _doesn’t_ notify you when its content changes. Mutating the `.current` property **doesn’t cause a re-render**.

And that’s when it hit me:

### We didn’t need to store the side drawer’s state — we only needed a reference to the function that sets that state.

## The Solution

1. Keep the open and cell states in the side drawer.

2. Create a ref to those states and store it in the context.

3. Call the set state functions (inside the side drawer) using the ref from the table when the user clicks on a cell.

![Diagram representing the preceding list](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/7ocqb0cu860h0766mboy.png)

The code below is an abbreviated version of the code used on Rowy and includes the TypeScript types for the ref:

{% gist https://gist.github.com/notsidney/2fa3f77a4c068322528aa897a7ae75d5 %}

<aside><small><i>Side note: since function components run the entire function body on re-render, whenever the <code>cell</code> or <code>open</code> state updates (and causes a re-render), <code>sideDrawerRef</code> always has the latest value in <code>.current</code>.</i></small></aside>

This solution proved to be the best since:

1. The current cell and open states are stored inside the side drawer component itself, the most logical place to put it.

2. The table component has access to its sibling’s state _when_ it needs it.

3. When either the current cell or open states are updated, it only triggers a re-render for the side drawer component and not any other component throughout the app.

You can see how this is used in Rowy [here](https://github.com/rowyio/rowy/blob/6e81191fc26714c4c212bae19cfc4c16440c322f/src/contexts/ProjectContext.tsx#L178) and [here](https://github.com/rowyio/rowy/blob/6e81191fc26714c4c212bae19cfc4c16440c322f/src/components/SideDrawer/index.tsx#L37).

## When to useRef

This doesn’t mean you should go ahead and use this pattern for everything you build, though. It’s best used for when you **need to access or update another component’s state at specific times, but your component doesn’t depend or render based on that state**. React’s core concepts of lifting state up and one-way data flow are enough to cover most app architectures anyway.

---

Thanks for reading! You can find out more about [Rowy](https://rowy.io/?utm_source=dev.to&utm_medium=blog&utm_campaign=How%20to%20useRef%20to%20Fix%20React%20Performance%20Issues) below and follow me on Twitter [@nots_dney](https://twitter.com/nots_dney).

{% github rowyio/rowy %}