bvaughn/react-error-boundary is a TypeScript project with 8.0k stars. Simple reusable React error boundary component
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
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.
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.
error Value that was thrown; typically an instance of Error
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.
Convenience hook for imperatively showing or dismissing error boundaries.
⚠️ This hook must only be used within an ErrorBoundary subtree.
Returns: The currently visible error (if one has been thrown), a resetBoundary method to reset and retry the nearest active error boundary, and a showBoundary method to display an error in the nearest error boundary
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.:
TopGit's last sync did not record any GitHub topics for bvaughn/react-error-boundary. GitHub topics appear in the right sidebar of a repository page; that's the authoritative place to check.
How active is development on bvaughn/react-error-boundary?
The most recent commit recorded on bvaughn/react-error-boundary was 3 days ago, based on the GitHub push timestamp. The repository has 230 forks — one of the better signals of community interest.
Is bvaughn/react-error-boundary open source?
Yes — bvaughn/react-error-boundary ships under the MIT license, which makes its source code freely readable (and, depending on license terms, forkable and reusable). Source: github.com/bvaughn/react-error-boundary.
What license does bvaughn/react-error-boundary use?
bvaughn/react-error-boundary is released under the MIT license. Always verify the LICENSE file directly on GitHub for the authoritative terms — license strings can be edited out of sync with a project's actual stance.
Where can I see bvaughn/react-error-boundary in action?
The project maintains a homepage at https://react-error-boundary-lib.vercel.app. The README tab on this page also usually contains screenshots and a quickstart.
Where do I read more about bvaughn/react-error-boundary?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/bvaughn/react-error-boundary is the definitive source.
Read full README in the tab above.
Want a second opinion on react-error-boundary?
Ask an AI that can read this page — one click and you get its take on react-error-boundary.