Skip to content

Commit 831150c

Browse files
[use] Rework await vs use DeepDive to fix inaccurate framing (#8521)
* Clarify use vs await * Refine based on feedback * Address review comments
1 parent 15299e5 commit 831150c

1 file changed

Lines changed: 23 additions & 11 deletions

File tree

  • src/content/reference/react

src/content/reference/react/use.md

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1113,47 +1113,59 @@ root.render(
11131113
11141114
#### Should I resolve a Promise in a Server or Client Component? {/*resolve-promise-in-server-or-client-component*/}
11151115
1116-
A Promise can be resolved with `await` in a Server Component, or passed as a prop to a Client Component and resolved there with `use`.
1116+
If you have a Promise, at some point you need to unwrap it to read its value. You unwrap it with `await` in a Server Component, and with `use` in a Client Component.
11171117
1118-
Using `await` in a Server Component suspends the Server Component itself, and the Client Component receives the resolved value as a prop:
1118+
Usually, the simplest option is to `await` the Promise where you create it. The Server Component suspends until the data is ready, and everything below it waits too:
11191119
11201120
```js
11211121
// Server Component
11221122
export default async function App() {
1123-
// Will suspend the Server Component.
11241123
const messageContent = await fetchMessage();
11251124
return <Message messageContent={messageContent} />;
11261125
}
11271126
```
11281127
1129-
A Server Component can also start a Promise without awaiting it and pass the Promise to a Client Component. The Server Component returns immediately, and the Client Component suspends when it calls `use`:
1128+
However, you don't have to unwrap it right away. You can pass the Promise down as a prop, and unwrap it deeper in the tree. The component that reads the Promise still suspends, but only that part of the tree waits for the data. Wrap that component in a [`<Suspense>`](/reference/react/Suspense) boundary to show a fallback while the rest of the page renders immediately.
1129+
1130+
For example, a deeper Server Component can `await` the Promise it receives:
11301131
11311132
```js
1133+
import { Suspense } from 'react';
1134+
11321135
// Server Component
11331136
export default function App() {
1134-
// Not awaited: starts here, resolves on the client.
11351137
const messagePromise = fetchMessage();
1136-
return <Message messagePromise={messagePromise} />;
1138+
return (
1139+
<Suspense fallback={<p>⌛Downloading message...</p>}>
1140+
<Message messagePromise={messagePromise} />
1141+
</Suspense>
1142+
);
1143+
}
1144+
1145+
// Server Component
1146+
async function Message({ messagePromise }) {
1147+
const messageContent = await messagePromise;
1148+
return <p>{messageContent}</p>;
11371149
}
11381150
```
11391151
1152+
Or, in a separate file, a Client Component can unwrap the same Promise with `use`:
1153+
11401154
```js
11411155
// Client Component
11421156
'use client';
1157+
11431158
import { use } from 'react';
11441159

11451160
export function Message({ messagePromise }) {
1146-
// Will suspend until the data is available.
11471161
const messageContent = use(messagePromise);
11481162
return <p>{messageContent}</p>;
11491163
}
11501164
```
11511165
1152-
Prefer `await` in a Server Component when possible, since it keeps the data fetching on the server. If a Server Component above already awaits the data, pass the resolved value down as a prop instead of creating a new Promise to call `use`.
1153-
1154-
You can also pass promise as a prop to a Client Component without awaiting it, and then read it with `use(promise)` to suspend deeper in the tree. This allows more of the surrounding UI to complete while the Promise is pending. A common case is interactive content like popovers and tooltips, where the data is needed only after a hover or click. Client Components can't `await`, so they rely on `use` to suspend on a Promise.
1166+
Passing the Promise down works the same way in both cases. Both suspend where the Promise is read, and both unblock the UI above. The only difference is that Client Components can't `await` during render, so they unwrap the Promise with `use` instead. A common case is interactive content like popovers and tooltips, where the data is only needed after a hover or click.
11551167
1156-
In either case, wrap the component that reads the Promise in a Suspense boundary so React can show a fallback while the Promise is pending. See [Revealing content together at once](/reference/react/Suspense#revealing-content-together-at-once) for guidance on boundary placement.
1168+
See [Revealing content together at once](/reference/react/Suspense#revealing-content-together-at-once) for guidance on where to place Suspense boundaries.
11571169
11581170
</DeepDive>
11591171

0 commit comments

Comments
 (0)