bvaughn/react-error-boundary

README

react-error-boundary: Reusable React error boundary component. Supports all React renderers (including React DOM and React Native).

If you like this project, 🎉 become a sponsor or ☕ buy me a coffee

Note

Projects using frameworks or runtimes that don't support ES Modules should use version 5 of this library.

Getting started

# npm
npm install react-error-boundary

# pnpm
pnpm add react-error-boundary

# yarn
yarn add react-error-boundary

Documentation

Read the react-error-boundary docs for examples, API reference, and troubleshooting. The docs also include a frequently asked questions guide.

Quick start

Wrap an ErrorBoundary around the part of the tree where you want to show a fallback UI if rendering fails. Your fallback can call resetErrorBoundary to clear the error and retry rendering:

"use client";

import { ErrorBoundary, getErrorMessage } from "react-error-boundary";

export default function App() {
  return (
    <ErrorBoundary
      fallbackRender={({ error, resetErrorBoundary }) => (
        <div role="alert">
          <p>Something went wrong:</p>
          <pre>{getErrorMessage(error)}</pre>
          <button onClick={resetErrorBoundary}>Try again</button>
        </div>
      )}
      onError={(error, info) => {
        // Log the error to your error reporting service
      }}
      onReset={() => {
        // Reset any state that may have caused the error
      }}
    >
      {/* Components protected by this boundary */}
    </ErrorBoundary>
  );
}

What errors are caught?

This package is built on top of React error boundaries, so it follows React's rules for what errors are caught.

Error boundaries catch errors thrown while rendering the tree below them.

Error boundaries do not catch errors from:

Server-side rendering
Event handlers
The error boundary itself
Async code that runs after rendering, like setTimeout callbacks or unresolved promises

Event handler and async errors

For event handler errors and async callback errors:

Use useErrorBoundary to pass caught errors to the nearest boundary.
In React 19, useTransition Actions can be an alternative: errors thrown from a function passed to the returned startTransition function are caught by the nearest boundary.

"use client";

import { useTransition } from "react";
import { ErrorBoundary } from "react-error-boundary";

function AddCommentContainer() {
  return (
    <ErrorBoundary fallback={<p>Could not add comment</p>}>
      <AddCommentButton />
    </ErrorBoundary>
  );
}

function AddCommentButton() {
  const [isPending, startTransition] = useTransition();

  function handleClick() {
    startTransition(async () => {
      await addComment();
    });
  }

  return (
    <button disabled={isPending} onClick={handleClick}>
      {isPending ? "Adding..." : "Add comment"}
    </button>
  );
}

API

ErrorBoundary

A reusable React error boundary component. Wrap this component around other React components to "catch" errors and render a fallback UI.

Catches errors thrown while rendering the tree below it.

Does not catch errors from:

Server-side rendering
Event handlers
The error boundary itself
Async code that runs after rendering, like setTimeout callbacks or unresolved promises

Event handler and async errors:

Use useErrorBoundary to pass caught errors to the nearest boundary
In React 19, errors thrown from a function passed to the startTransition function returned by useTransition are caught by the nearest boundary

ℹ️ The component provides several ways to render a fallback: fallback, fallbackRender, and FallbackComponent. Refer to the documentation to determine which is best for your application.

ℹ️ This is a client component. You can only pass props to it that are serializable or use it in files that have a "use client"; directive.

Required props

None

Optional props

Name	Description
onError	Optional callback to enable e.g. logging error information to a server. @param error Value that was thrown; typically an instance of `Error` @param info React "component stack" identifying where the error was thrown
onReset	Optional callback to be notified when an error boundary is reset so React can retry the failed render.
resetKeys	When changed, these keys will reset a triggered error boundary. This can be useful when an error condition may be tied to some specific state (that can be uniquely identified by key). See the documentation for examples of how to use this prop.
fallback	Static content to render in place of an error if one is thrown. `<ErrorBoundary fallback={<div className="text-red">Something went wrong</div>} />`
FallbackComponent	React component responsible for returning a fallback UI based on a thrown value. `<ErrorBoundary FallbackComponent={Fallback} />`
fallbackRender	Render prop function responsible for returning a fallback UI based on a thrown value. `<ErrorBoundary fallbackRender={({ error, resetErrorBoundary }) => <div>...</div>} />`

FAQ

`ErrorBoundary` cannot be used as a JSX component

This error can be caused by a version mismatch between react and @types/react. To fix this, ensure that both match exactly, e.g.:

If using NPM:

{
  ...
  "overrides": {
    "@types/react": "17.0.60"
  },
  ...
}

If using Yarn:

{
  ...
  "resolutions": {
    "@types/react": "17.0.60"
  },
  ...
}

This blog post shows more examples of how this package can be used, although it was written for the version 3 API.