-
Notifications
You must be signed in to change notification settings - Fork 7.9k
[Suspense] Document what activates a boundary, with live examples #8505
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 11 commits
0f92fef
4ddc1e3
021f94d
14e8f67
d34d3ce
2e01ae7
f6d28e6
16fa091
54958a7
6f6185d
b7c2094
201b5e3
d2df82a
b33c637
9091bee
9be6345
025ee7a
2dfe10f
567cdd4
c45c9b0
1ed5be2
3eb0f38
dd5449e
d63cade
d56099a
2942718
551cdf6
0d41392
5cc4a30
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -29,8 +29,10 @@ title: <Suspense> | |
|
|
||
| #### Caveats {/*caveats*/} | ||
|
|
||
| - Suspense does not detect when data is fetched inside an Effect or event handler. It only activates for the [resources listed below.](#what-activates-a-suspense-boundary) | ||
| - React does not preserve any state for renders that got suspended before they were able to mount for the first time. When the component has loaded, React will retry rendering the suspended tree from scratch. | ||
| - If Suspense was displaying content for the tree, but then it suspended again, the `fallback` will be shown again unless the update causing it was caused by [`startTransition`](/reference/react/startTransition) or [`useDeferredValue`](/reference/react/useDeferredValue). | ||
| - React reveals suspended content at most once every 300ms. When a boundary's content is ready, React waits until 300ms have passed since the last reveal before showing it, so that boundaries resolving within that window are [revealed together](/blog/2025/10/01/react-19-2#batching-suspense-boundaries-for-ssr) rather than one at a time. | ||
| - If React needs to hide the already visible content because it suspended again, it will clean up [layout Effects](/reference/react/useLayoutEffect) in the content tree. When the content is ready to be shown again, React will fire the layout Effects again. This ensures that Effects measuring the DOM layout don't try to do this while the content is hidden. | ||
| - React includes under-the-hood optimizations like *Streaming Server Rendering* and *Selective Hydration* that are integrated with Suspense. Read [an architectural overview](https://github.com/reactwg/react-18/discussions/37) and watch [a technical talk](https://www.youtube.com/watch?v=pj5N-Khihgc) to learn more. | ||
|
|
||
|
|
@@ -203,22 +205,221 @@ async function getAlbums() { | |
|
|
||
| </Sandpack> | ||
|
|
||
| <Note> | ||
| --- | ||
|
|
||
| ### What activates a Suspense boundary {/*what-activates-a-suspense-boundary*/} | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Very excited to see these being called out and updated! My understanding is that a "suspense enabled framework" is a framework that wraps these features that activates a suspense boundaries . If that is true could we specifically call it out what suspense enabled means?
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Maybe this? 021f94d |
||
|
|
||
| **Only Suspense-enabled data sources will activate the Suspense component.** They include: | ||
| A Suspense boundary waits for its content to be ready before revealing it. Any of the following blocks a boundary's content from being revealed: | ||
|
|
||
| - Data fetching with Suspense-enabled frameworks like [Relay](https://relay.dev/docs/guided-tour/rendering/loading-states/) and [Next.js](https://nextjs.org/docs/app/building-your-application/routing/loading-ui-and-streaming#streaming-with-suspense) | ||
| - Lazy-loading component code with [`lazy`](/reference/react/lazy) | ||
| - Reading the value of a cached Promise with [`use`](/reference/react/use) | ||
| - Lazy-loading component code with [`lazy`](/reference/react/lazy). | ||
| - Reading a Promise with [`use`](/reference/react/use), including data streamed from [Server Components](/reference/rsc/server-components) and integrations from frameworks like [Relay](https://relay.dev/docs/guided-tour/rendering/loading-states/). | ||
| - Loading a stylesheet rendered with [`<link rel="stylesheet">` and a `precedence` prop.](/reference/react-dom/components/link#special-rendering-behavior) React blocks the boundary until the stylesheet loads, up to a timeout. | ||
| - Loading fonts. React blocks a streamed boundary until [`document.fonts.ready`](https://developer.mozilla.org/en-US/docs/Web/API/FontFaceSet/ready) resolves, up to a timeout. Fonts also block a [`<ViewTransition>`](/reference/react/ViewTransition) update. | ||
|
aurorascharff marked this conversation as resolved.
Outdated
|
||
| - Streaming a large boundary's HTML during server rendering. React reveals the content as the HTML arrives. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The other examples are probably self-explanatory. This one could do with an example. Examples for all would be nice with a side-by-side with a Suspense implementation that wouldn't block (e.g. with just some simple DOM operations).
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. How about with effect as an example? It's a common confusion
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. That's for
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I see. I must have misunderstood. I'm wondering if the example you are referring to is too low level for the suspense page, but would fit nicely in the prerender or resume docs. I also think keeping this current example is quite a nice way to show this common misconception. I've added now a link to those docs here, we can add the example on that page? 201b5e3 possibly in a follow-up PR
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It's any SSR API with support for streaming. The whole point for me was to explain Suspense in a single place. It isn't low-level because it explains how React thinks about Suspense.
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. oh, gotcha, will add!
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. So I simplified my example. Still open to removing the whole use affecting if we don't think it's necessary, and then I added your example. |
||
| - Loading an image, where the `src` blocks the boundary until the image loads. This behavior is not enabled by default. When enabled, an `onLoad` handler opts an image out, and images in a [`<ViewTransition>`](/reference/react/ViewTransition) update opt in automatically. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
this is confusing. when is it enabled, if it's not enabled by default?
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @eps1lon do you know about this?
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. If inside ViewTransition, every images is opted in. Adding So priority is: default -> is inside by default it's currently disabled. |
||
| - <ExperimentalBadge /> Performing CPU-bound render work inside a `<Suspense>` boundary marked with the `defer` prop. | ||
|
|
||
| <Note> | ||
|
|
||
| Suspense **does not** detect when data is fetched inside an Effect or event handler. | ||
| #### What is a Suspense-enabled framework? {/*what-is-a-suspense-enabled-framework*/} | ||
|
|
||
| The exact way you would load data in the `Albums` component above depends on your framework. If you use a Suspense-enabled framework, you'll find the details in its data fetching documentation. | ||
| A *Suspense-enabled framework* reads data with [`use`](/reference/react/use) under the hood, so that reading data in a component activates the nearest boundary. The exact way you load data in the `Albums` component above depends on your framework, and you'll find the details in its data fetching documentation. | ||
|
aurorascharff marked this conversation as resolved.
Outdated
|
||
|
|
||
| Suspense-enabled data fetching without the use of an opinionated framework is not yet supported. The requirements for implementing a Suspense-enabled data source are unstable and undocumented. An official API for integrating data sources with Suspense will be released in a future version of React. | ||
| Without a framework, you can read a Promise with `use` directly, as long as the Promise is [cached so the same instance is reused across renders.](/reference/react/use#caching-promises-for-client-components) | ||
|
|
||
| </Note> | ||
|
|
||
| For example, both boundaries below are set up identically. The one on the left activates because its content reads a Promise with `use`, so it shows the `fallback` while loading. The one on the right fetches the same data inside an Effect, which Suspense can't detect, so its `fallback` never appears and the albums simply show up once the fetch resolves: | ||
|
|
||
| <Sandpack> | ||
|
|
||
| ```js | ||
| import { Suspense } from 'react'; | ||
| import Albums from './Albums.js'; | ||
| import EffectAlbums from './EffectAlbums.js'; | ||
|
|
||
| export default function App() { | ||
| return ( | ||
| <div className="panels"> | ||
| <section className="panel"> | ||
| <h2>Reads a Promise with use</h2> | ||
| <Suspense fallback={<Loading />}> | ||
| <Albums artistId="the-beatles" /> | ||
| </Suspense> | ||
| </section> | ||
| <section className="panel"> | ||
| <h2>Fetches in an Effect</h2> | ||
| <Suspense fallback={<Loading />}> | ||
| <EffectAlbums artistId="the-beatles" /> | ||
| </Suspense> | ||
| </section> | ||
| </div> | ||
| ); | ||
| } | ||
|
|
||
| function Loading() { | ||
| return <p>🌀 Loading...</p>; | ||
| } | ||
| ``` | ||
|
|
||
| ```js src/Albums.js active | ||
| import { use } from 'react'; | ||
| import { fetchData } from './data.js'; | ||
|
|
||
| export default function Albums({ artistId }) { | ||
| // Reading the Promise with `use` activates | ||
| // the Suspense boundary while it loads. | ||
| const albums = use(fetchData(`/${artistId}/albums`)); | ||
| return ( | ||
| <ul> | ||
| {albums.map(album => ( | ||
| <li key={album.id}> | ||
| {album.title} ({album.year}) | ||
| </li> | ||
| ))} | ||
| </ul> | ||
| ); | ||
| } | ||
| ``` | ||
|
|
||
| ```js src/EffectAlbums.js | ||
| import { useState, useEffect } from 'react'; | ||
| import { fetchData } from './data.js'; | ||
|
|
||
| export default function EffectAlbums({ artistId }) { | ||
| const [albums, setAlbums] = useState([]); | ||
|
|
||
| useEffect(() => { | ||
| let active = true; | ||
| fetchData(`/${artistId}/albums`).then(result => { | ||
| if (active) { | ||
| setAlbums(result); | ||
| } | ||
| }); | ||
| return () => { | ||
| active = false; | ||
| }; | ||
| }, [artistId]); | ||
|
|
||
| // Suspense can't see this fetch, so its fallback never | ||
| // shows. The list stays empty until the data arrives. | ||
| return ( | ||
| <ul> | ||
| {albums.map(album => ( | ||
| <li key={album.id}> | ||
| {album.title} ({album.year}) | ||
| </li> | ||
| ))} | ||
| </ul> | ||
| ); | ||
| } | ||
| ``` | ||
|
|
||
| ```js src/data.js hidden | ||
| // Note: the way you would do data fetching depends on | ||
| // the framework that you use together with Suspense. | ||
| // Normally, the caching logic would be inside a framework. | ||
|
|
||
| let cache = new Map(); | ||
|
|
||
| export function fetchData(url) { | ||
| if (!cache.has(url)) { | ||
| cache.set(url, getData(url)); | ||
| } | ||
| return cache.get(url); | ||
| } | ||
|
|
||
| async function getData(url) { | ||
| if (url === '/the-beatles/albums') { | ||
| return await getAlbums(); | ||
| } else { | ||
| throw Error('Not implemented'); | ||
| } | ||
| } | ||
|
|
||
| async function getAlbums() { | ||
| // Add a fake delay to make waiting noticeable. | ||
| await new Promise(resolve => { | ||
| setTimeout(resolve, 3000); | ||
| }); | ||
|
|
||
| return [{ | ||
| id: 13, | ||
| title: 'Let It Be', | ||
| year: 1970 | ||
| }, { | ||
| id: 12, | ||
| title: 'Abbey Road', | ||
| year: 1969 | ||
| }, { | ||
| id: 11, | ||
| title: 'Yellow Submarine', | ||
| year: 1969 | ||
| }, { | ||
| id: 10, | ||
| title: 'The Beatles', | ||
| year: 1968 | ||
| }, { | ||
| id: 9, | ||
| title: 'Magical Mystery Tour', | ||
| year: 1967 | ||
| }, { | ||
| id: 8, | ||
| title: 'Sgt. Pepper\'s Lonely Hearts Club Band', | ||
| year: 1967 | ||
| }, { | ||
| id: 7, | ||
| title: 'Revolver', | ||
| year: 1966 | ||
| }, { | ||
| id: 6, | ||
| title: 'Rubber Soul', | ||
| year: 1965 | ||
| }, { | ||
| id: 5, | ||
| title: 'Help!', | ||
| year: 1965 | ||
| }, { | ||
| id: 4, | ||
| title: 'Beatles For Sale', | ||
| year: 1964 | ||
| }, { | ||
| id: 3, | ||
| title: 'A Hard Day\'s Night', | ||
| year: 1964 | ||
| }, { | ||
| id: 2, | ||
| title: 'With The Beatles', | ||
| year: 1963 | ||
| }, { | ||
| id: 1, | ||
| title: 'Please Please Me', | ||
| year: 1963 | ||
| }]; | ||
| } | ||
| ``` | ||
|
|
||
| ```css | ||
| .panels { | ||
| display: flex; | ||
| gap: 20px; | ||
| } | ||
|
|
||
| .panel { | ||
| flex: 1; | ||
| border: 1px solid #aaa; | ||
| border-radius: 6px; | ||
| padding: 10px; | ||
| } | ||
|
|
||
| .panel h2 { | ||
| margin-top: 0; | ||
| font-size: 1rem; | ||
| } | ||
| ``` | ||
|
|
||
| </Sandpack> | ||
|
|
||
| --- | ||
|
|
||
| ### Revealing content together at once {/*revealing-content-together-at-once*/} | ||
|
|
||

There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I opened issue #8490 about the need for a caveat regarding React's batching of Suspense content, which has resulted in several issues in the React repo that can be solved with documentation. If we can add it to this pr, it would be great. I am thinking something like this:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@eps1lon can you verify this number?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
d34d3ce added here but happy to revert
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
React waits at least 300ms before replacing the fallback with new content. That's different to blocking display of a fallback which only happens during updates in Transitions.
The idea is that filling in content more often leads to a "popcorn" effect. Imagine a 10x10 grid where each cell pops in 50ms intervals instead of doing 2-3 reveals including multiple cells. 300ms is just a heuristic that allows batching reveal of multiple boundaries.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Simplified 16fa091 and added link 54958a7
not quite sure i understood what you wanted though
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like your caveat much better than my suggestion (great job!). But I feel like it implies that suspense will always show a fallback.
My understanding is that
0ms to ~10 ms - no fallback; suspense just renders children
11ms to ~300ms - batch at call; all render all together after 300ms
~310ms+ render in 300ms windows (not sure about this one)
This is figuring out an ideal rendering schedule; it is very impressive work by the React team, but is a little hard to explain. I hope I am not derailing the goals of this pr.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would need @eps1lon here to confirm and define what docs should include
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The throttling heuristic always blocks new boundary reveals counting from the last reveal. It has no impact on whether we display a fallback or not which is decided independently (always show fallback on mount, stay on content on update).
The very first boundary React will always reveal asap. If the boundary suspended, React shows a fallback immediately. When the boundary unsuspends, React will not reveal the boundaries content before 300ms have elapsed since the last reveal.
Throttling is surfaced in the performance tracks added by React.
Consider this example (using https://codesandbox.io/p/sandbox/quiet-http-yplr4n):
All Promises start at the same time as we can commit shell (which doesn't suspend and is committed instantly).
p1 resolves at 100ms
p2 resolves at 450ms
p3 resolves at 850ms
When p1 resolves we committed the root boundary (what we commonly refer to as "the shell") 100ms earlier. Since we don't want to reveal more often than every 300ms, we throttle for 200ms and reveal lvl 1 at 300ms.
When p2 resolves at 450ms, lvl1 was revealed 150ms earlier. Since we don't want to reveal more often than every 300ms, we throttle for 150ms and reveal lvl 2 at 600ms.
When p3 resolves at 850ms, lv2 was revealed 250ms earlier. Since we don't want to reveal more often than every 300ms, we throttle for 50ms and reveal lvl 2 at 900ms.
CleanShot.2026-07-01.at.14.59.48.mp4
The batching can be observed when you let two boundaries resolve within the same 300ms window e.g.
p1 resolves at 100ms
p2 resolves at 350ms
p3 resolves at 450ms
p1 is throttled for 200ms
p2 is throttled for 250ms
p3 is throttled for 150ms
p2 and p3 are revealed together.
CleanShot.2026-07-01.at.15.05.25.mp4
Without throttling all would commit independently within a short timeframe.
Throttling is global so it doesn't just apply to parent-child reveals. Initially, React throttled to 500ms which got reduced to 300ms in React 19. In React 19 we also applied throttling more broadly. The initial version of Suspense revealed boundaries immediately if there were no more nested boundaries.