Skip to content

Refresh error boundary docs and examples - #240

Merged
bvaughn merged 5 commits into
bvaughn:mainfrom
aurorascharff:refresh-error-boundary-docs
May 25, 2026
Merged

bvaughn merged 5 commits into
bvaughn:mainfrom
aurorascharff:refresh-error-boundary-docs

Conversation

@aurorascharff

@aurorascharff aurorascharff commented May 24, 2026 •

Copy link
Copy Markdown
Contributor

What

Refreshes the README and docs site so the first-pass docs explain the modern react-error-boundary workflow more directly.

  • add a README quick start with inline fallbackRender, retry/reset, and logging
  • add clear “what errors are caught” and “async errors” sections
  • refresh the ErrorBoundary source/API comment with compact, current catch rules
  • document the React 19 useTransition Action path for async errors
  • add a dedicated transition errors docs example

Why

React's error boundary docs still show the class-component primitive, while function-component users often land here for a reusable boundary. The existing docs explain the API, but the React 19 async behavior is easy to miss.

This keeps useErrorBoundary positioned as the manual path for async work outside Actions, while documenting that errors thrown from a function passed to the startTransition function returned by useTransition can be caught by the nearest boundary.

Generated docs, examples, and search artifacts were updated from the refreshed examples and JSDoc.

@vercel

vercel Bot commented May 24, 2026

Copy link
Copy Markdown

@aurorascharff is attempting to deploy a commit to the Brian Vaughn's projects Team on Vercel.

A member of the Team first needs to authorize it.

@aurorascharff
aurorascharff force-pushed the refresh-error-boundary-docs branch from da794f0 to b4c87eb Compare May 24, 2026 20:29
@aurorascharff aurorascharff changed the title Refresh error boundary docs Clarify React 19 error boundary docs May 24, 2026
@aurorascharff aurorascharff changed the title Clarify React 19 error boundary docs Refresh error boundary docs and examples May 24, 2026
@vercel

vercel Bot commented May 24, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
react-error-boundary Ready Ready Preview May 25, 2026 12:52am

@aurorascharff
aurorascharff marked this pull request as ready for review May 24, 2026 21:40
Copilot AI review requested due to automatic review settings May 24, 2026 21:40
@aurorascharff
aurorascharff marked this pull request as draft May 24, 2026 21:42

This comment was marked as low quality.

@bvaughn bvaughn left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Aurora! This is such a helpful PR 🙇🏼

@bvaughn
bvaughn marked this pull request as ready for review May 24, 2026 21:50
@aurorascharff

Copy link
Copy Markdown
Contributor Author

Thanks Aurora! This is such a helpful PR 🙇🏼

Pushing some small tweaks and then it should be good!! 🤩

@bvaughn

bvaughn commented May 24, 2026

Copy link
Copy Markdown
Owner

Let me know when you're happy with things and I'll merge!

@bvaughn

bvaughn commented May 24, 2026 •

Copy link
Copy Markdown
Owner

(I was hoping that updated the react-lib-tools dep would fix the failing CI job. Unfortunately it didn't. Sorry for the noise. Feel free to force-push over top of my commit if that's more convenient, and I'll debug this in another branch like I should have done to begin with)

@bvaughn bvaughn mentioned this pull request May 24, 2026
@aurorascharff
aurorascharff force-pushed the refresh-error-boundary-docs branch 2 times, most recently from 5aca0fe to 4df9a7f Compare May 24, 2026 22:17
@aurorascharff
aurorascharff force-pushed the refresh-error-boundary-docs branch from 4df9a7f to 07f92fa Compare May 24, 2026 22:24
@aurorascharff
aurorascharff marked this pull request as ready for review May 24, 2026 22:26
@aurorascharff

Copy link
Copy Markdown
Contributor Author

@bvaughn Check it out, I'm done tweaking!

@bvaughn bvaughn left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great 👍🏼 Thank you!

@bvaughn
bvaughn merged commit 09b1522 into bvaughn:main May 25, 2026
5 of 6 checks passed
@bvaughn

bvaughn commented May 25, 2026

Copy link
Copy Markdown
Owner

Readme updates have been published in react-error-boundary@6.1.2

This branch was successfully deployed

1 active deployment
Preview — 07f92fad Deployed May 25, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants