• Home
  • Blog
  • Projects
  • Bookshelf
  • About
← Back to all posts

React Error Boundaries

Published ....
Last modified ....

Share this post on BlueskySee discussion on Bluesky

The other week I got an email from a developer wondering if I could help them learn more about Error Boundaries within React.

I figured that instead of sharing that information directly to them, I would spend a bit more time writing it up in a blog post so others could learn from the content as well. This post is only meant as a brief introduction to the concept behind Error Boundaries within React, for more advanced information refer to the where can I learn more section at the bottom of the page.

So lets dive in!

What are Error Boundaries?

Simply put, you can think of Error Boundaries as try ... catch blocks within a component tree. This is an example of a try catch block:

try {
  doSomethingThatMayThrow();
} catch (error) {
  handleError(error);
}

In that snippet above, the doSomethingThatMayThrow function can throw anything (generally an error) and the catch block will capture this thrown value and continue script execution.

In React this would look like something like the following:

<ErrorBoundary>
  <ComponentThatMayThrow />
</ErrorBoundary>

Great, so we have a rough understanding of what they look like in practice, but how do they actually work?

How do Error Boundaries Work?

An error boundary can be implemented within any component that uses either the:

  • componentDidCatch or
  • getDerivedStateFromError

lifecycle methods. Both of these methods allow the component to catch an error thrown from its children.

So lets setup a simple generic Error Boundary component.

class ErrorBoundary extends React.Component {
  state = {
    hasCaughtError: false,
  };
  componentDidCatch(error) {
    this.setState({ hasCaughtError: true });
  }
  render() {
    if (this.state.hasCaughtError) {
      return <p>Oh no, an error has occurred</p>;
    }
    return this.props.children;
  }
}

In this component above, whenever some component anywhere within its children throws an error, React will propagate that error up to this component, and call its componentDidCatch lifecycle method with the error that was thrown.

This component can then setState to change the children returned from render in order to recover from that thrown error.

Caveats

As with most things, there are some caveats with this workflow. The first and most notable, is that this component will only catch errors thrown during the render phase. This means that if an error occurs within a callback that is not a setState updater, the error boundary component will not catch it.

Another caveat, or feature I guess is that if you do want to catch a particular error from an event handler higher up in the component tree at your error boundary, you can throw from within a setState:

import { Component } from "react";

export default class Example extends Component {
  handleChange = (e) => {
    let {
      target: { value },
    } = e;
    this.setState(() => {
      if (value.includes("foo")) {
        throw new Error("Error!");
      }
      return null;
    });
  };
  render() {
    return (
      <input
        onChange={this.handleChange}
        placeholder="Try typing here!"
        style={{
          height: 35,
          fontSize: 18,
          width: "calc(100% - 2em)",
          padding: "1rem",
        }}
      />
    );
  }
}

A note on getDerivedStateFromError

The getDerivedStateFromError lifecycle was introduced later than the componentDidCatch lifecycle, and operates on a similar mechanism as the getDerivedStateFromProps lifecycle method in that it is a single pass handler. This means that React is able to reconcile the error handling within the same rendering batch as when the error occurs, I think. I don't really understand what this actually means however, so take this with a grain of salt 🧂 .

Where can I learn more?

As always, the ReactJS first party docs site is hands down one of the best resources out there about React. Here is a great getting started introduction to Error Boundaries on the ReactJS Docs.

Tags:

Web DevelopmentReact

Loading...

Related Posts

Web Development

Website Redesign v11

....

I've once again updated my personal website, this time powered by my own RSC framework and a custom CMS solution as well!

Onboarding Your New AI Teammate

....

Are we reinventing the wheel when it comes to onboarding new AI agents to a codebase, when we already have primitives available for onboarding humans?

Quick Tip - Theme Aware Images

....

Have you ever found the need to change the image you render on a web page based on the current preferred color scheme of your theme?

Async Class Creation In JavaScript

....

Have you ever wanted to create a class in JavaScript or TypeScript but also have the initialization be async? Here's a quick tip on a pattern that I've used in the past!

Website Redesign v10

....

I recently launched a rewrite and redesign of this personal website, I figured I'd talk a bit about the changes and new features that I added along the way!

Server Side Rendering Compatible CSS Theming

....

A quick tip to implementing CSS theming that's compatible with Server Side Rendered applications!

Podcasting By Hand

....

A brief overview on how we launched The Bikeshed Podcast, including a deep dive in our recording and distribution workflows!

Quick Tip - Specific Local Module Declarations

....

A quick tip outlining how to provide specific TypeScript type definitions for a local module!

On File-System Routing Conventions

....

Some rough thoughts on building a file-system routing based web application

You're Building Software Wrong

....

Slicing software: why vertical is better than horizontal.

Single File Web Apps

....

What if you could author an entire web application in a single file?

Resetting Controlled Components in Forms

....

A quick way to handle resetting internal state in components when a parent form is submitted!

A Quick Look at Import Maps

....

A brief look at Import Maps and package.json#imports to support isomorphic JavaScript applications!

Recommended Tech Talks

....

A collection of tech talks that I regularly re-watch and also recommend to everyone!

Request for a (minimal) RSC Framework

....

Some features and functionality that I'd like within a React Server Component compatible framework.

Bluesky Tips and Tools

....

A (running) collection of Bluesky tips, tools, packages, and other misc things!

The Bookkeeping Pattern

....

A quick look at a small but powerful pattern I've been leveraging as of late!

TSLite

....

A proposal for a minimal variant of TypeScript!

Monorepo Tips and Tricks

....

Sharing a few core recommendations when working within monorepos to make your life easier!

Next.js with Deno v2

....

This is a quick post noting that Next.js should now work with Deno v2!

Don't Break the Implicit Prop Contract

....

React components have a fundamental contract that is often unstated in their implementation, and you should know about it!

A Better useSSR Implementation

....

Replace that old useState and useEffect combo for a new and better option!

My Current Dev Setup

....

A quick look at the applications and tools that I (generally) use day to day for web development!

Abstract Your API

....

Proposing a solution for sharing core "business" logic across services!

Tip: Request and Response Headers

....

There's a common gotcha when creating Web Request and Response instances with Headers!

Using Feature Toggles to De-risk Refactors

....

Feature toggles are often underused by most software development teams, and yet offer so much value during not only feature development but also refactors

Hohoro

....

A quick introduction to my new side project, hohoro. An incremental JS/TS library build tool!

Custom Favicon Recipes

....

Two neat tricks for enhancing your site's favicon!

Corporate Sponsored OSS

....

The various risks and pitfalls of open source software run by corporations.

The Library-Docs Monorepo Template

....

A monorepo template for managing a library and documentation together.

Building Better Beacon

....

How we solved an almost show-stopping production bug, and how you can avoid it in your own projects.

Project Deep Dive: Tails

....

A(nother) deep dive into one of my recent side projects; tails - a plain and simple cocktail recipe app.

Churn Anxiety

....

When did semver major changes become so scary?

Service Monitors and Observability

....

Leveraging service monitors properly to improve service observability.

On Adopting CSS-in-JS

....

A brief recap of how Wayfair changed it's CSS approach not once but twice in the span of 5 years!

Project Deep Dive: Microfibre

....

A deep dive into one of my recent side projects; microfibre - a minimal text posting application

Pair Programming

....

Pair programming can be good sometimes - but not all the time

Suspense Plus GraphQL

....

A few thoughts on using Suspense with GraphQL to optimize application data loading

You've Launched, Now What?

....

A few thoughts on what to do after you launch a new project

Taking a Break

....

A few quick thoughts on burn out and taking a break

Managing Complex UI Component State

....

A few thoughts on managing complex UI component state within React

Understanding React 16.3 Updates

....

A quick overview of the new lifecycle methods introduced in React 16.3

CSS in JS

....

A few thoughts and patterns for using styled-jsx or other CSS-in-JS solutions

Redesign v6

....

A few thoughts on the redesign of my personal site, adopting Next.js and deploying via Now

JavaScript Weirdness

....

A few weird things about JavaScript

Calendar

....

Building a calendar web application

React

Multi-step Native HTML Forms

....

useInterval

....

Server Side Rendering Compatible CSS Theming

....

A quick tip to implementing CSS theming that's compatible with Server Side Rendered applications!

Resetting Controlled Components in Forms

....

A quick way to handle resetting internal state in components when a parent form is submitted!

Request for a (minimal) RSC Framework

....

Some features and functionality that I'd like within a React Server Component compatible framework.

Don't Break the Implicit Prop Contract

....

React components have a fundamental contract that is often unstated in their implementation, and you should know about it!

A Better useSSR Implementation

....

Replace that old useState and useEffect combo for a new and better option!

React Error Boundaries: Revisited

....

Revising my previous blog post on React Error Boundaries and my preferred go-to implementation!

Suspense Plus GraphQL

....

A few thoughts on using Suspense with GraphQL to optimize application data loading

Managing Complex UI Component State

....

A few thoughts on managing complex UI component state within React

Understanding React 16.3 Updates

....

A quick overview of the new lifecycle methods introduced in React 16.3