You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Edits for new "use client" content
* Apply suggestions from code review
Co-authored-by: Luna <lunaleaps@gmail.com>
---------
Co-authored-by: Luna <lunaleaps@gmail.com>
Copy file name to clipboardExpand all lines: src/content/reference/react/use-client.md
+53-49Lines changed: 53 additions & 49 deletions
Original file line number
Diff line number
Diff line change
@@ -31,20 +31,19 @@ Add `'use client'` at the top of a file to mark the module and its transitive de
31
31
32
32
import { useState } from'react';
33
33
import { formatDate } from'./formatters';
34
-
importLinkfrom'./link';
34
+
importButtonfrom'./button';
35
35
36
-
exportdefaultfunctionRichTextEditor(props) {
37
-
formatDate();
36
+
exportdefaultfunctionRichTextEditor({ timestamp, text }) {
37
+
constdate=formatDate(timestamp);
38
+
// ...
39
+
consteditButton=<Button />;
38
40
// ...
39
-
return
40
-
<Link />
41
-
// ...
42
41
}
43
42
```
44
43
45
44
When a file marked with `'use client'` is imported from a Server Component, [compatible bundlers](/learn/start-a-new-react-project#bleeding-edge-react-frameworks) will treat the module import as a boundary between server-run and client-run code.
46
45
47
-
As a dependency of `RichTextEditor`, `formatDate` and `Link` will also be evaluated on the client regardless of whether their modules contain a `'use client'` directive. Note that the same module may be evaluated on the server when imported from server code and on the client when imported from client code.
46
+
As dependencies of `RichTextEditor`, `formatDate` and `Button` will also be evaluated on the client regardless of whether their modules contain a `'use client'` directive. Note that a single module may be evaluated on the server when imported from server code and on the client when imported from client code.
48
47
49
48
#### Caveats {/*caveats*/}
50
49
@@ -59,9 +58,9 @@ As a dependency of `RichTextEditor`, `formatDate` and `Link` will also be evalua
59
58
60
59
In a React app, components are often split into separate files, or [modules](/learn/importing-and-exporting-components#exporting-and-importing-a-component).
61
60
62
-
For apps that use React Server Components, the app is server-rendered by default. `'use client'` introduces a server-client boundary in the [module dependency tree](/learn/understanding-your-ui-as-a-tree#the-module-dependency-tree), effectively creating a client-module subtree.
61
+
For apps that use React Server Components, the app is server-rendered by default. `'use client'` introduces a server-client boundary in the [module dependency tree](/learn/understanding-your-ui-as-a-tree#the-module-dependency-tree), effectively creating a subtree of client modules.
63
62
64
-
To better illustrate this, consider the following React Server Component app and its module dependency and render tree.
63
+
To better illustrate this, consider the following React Server Components app.
65
64
66
65
<Sandpack>
67
66
@@ -146,12 +145,12 @@ export default [
146
145
147
146
</Sandpack>
148
147
148
+
In the module dependency tree of this example app, the `'use client'` directive in `InspirationGenerator.js` marks that module and all of its transitive dependencies as client modules. The subtree starting at `InspirationGenerator.js` is now marked as client modules.
149
+
149
150
<Diagramname="use_client_module_dependency"height={250}width={545}alt="A tree graph with the top node representing the module 'App.js'. 'App.js' has three children: 'Copyright.js', 'FancyText.js', and 'InspirationGenerator.js'. 'InspirationGenerator.js' has two children: 'FancyText.js' and 'inspirations.js'. The nodes under and including 'InspirationGenerator.js' have a yellow background color to signify that this sub-graph is client-rendered due to the 'use client' directive in 'InspirationGenerator.js'.">
150
-
`'use client'` segments the module dependency tree of the React Server Components app to mark `InspirationGenerator.js` and any of its dependencies as client-rendered.
151
+
`'use client'` segments the module dependency tree of the React Server Components app, marking `InspirationGenerator.js` and all of its dependencies as client-rendered.
151
152
</Diagram>
152
153
153
-
In the module dependency tree of the example app, the `'use client'` directive in `InspirationGenerator.js` marks that module and all of its transitive dependencies as client modules. It creates a subtree of client modules with `InspirationGenerator.js` as the root.
154
-
155
154
During render, the framework will server-render the root component and continue through the [render tree](/learn/understanding-your-ui-as-a-tree#the-render-tree), opting-out of evaluating any code imported from client-marked code.
156
155
157
156
The server-rendered portion of the render tree is then sent to the client. The client, with its client code downloaded, then completes rendering the rest of the tree.
@@ -179,7 +178,7 @@ First, let's clarify that the term "component" is not very precise. Here are jus
179
178
```js
180
179
// This is a definition of a component
181
180
functionMyComponent() {
182
-
return<p>My Component</p>
181
+
return<p>My Component</p>
183
182
}
184
183
```
185
184
@@ -188,8 +187,8 @@ function MyComponent() {
188
187
importMyComponentfrom'./MyComponent';
189
188
190
189
functionApp() {
191
-
// This is a usage of a component
192
-
return<MyComponent />;
190
+
// This is a usage of a component
191
+
return<MyComponent />;
193
192
}
194
193
```
195
194
@@ -215,39 +214,39 @@ This means that the component definition for `FancyText` will both be evaluated
215
214
216
215
#### Why is `Copyright` a Server Component? {/*why-is-copyright-a-server-component*/}
217
216
218
-
As a child of `InspirationGenerator`, a Client Component, why is `Copyright`a Server Component?
217
+
Because `Copyright` is rendered as a child of the Client Component `InspirationGenerator`, you might be surprised that it is a Server Component.
219
218
220
-
To clarify,`'use client'` defines the boundary between server and client code on the _module dependency tree_, not the render tree.
219
+
Recall that`'use client'` defines the boundary between server and client code on the _module dependency tree_, not the render tree.
221
220
222
221
<Diagramname="use_client_module_dependency"height={200}width={500}alt="A tree graph with the top node representing the module 'App.js'. 'App.js' has three children: 'Copyright.js', 'FancyText.js', and 'InspirationGenerator.js'. 'InspirationGenerator.js' has two children: 'FancyText.js' and 'inspirations.js'. The nodes under and including 'InspirationGenerator.js' have a yellow background color to signify that this sub-graph is client-rendered due to the 'use client' directive in 'InspirationGenerator.js'.">
223
222
`'use client'` defines the boundary between server and client code on the module dependency tree.
224
223
</Diagram>
225
224
226
225
In the module dependency tree, we see that `App.js` imports and calls `Copyright` from the `Copyright.js` module. As `Copyright.js` does not contain a `'use client'` directive, the component usage is rendered on the server. `App` is rendered on the server as it is the root component.
227
226
228
-
Client Components can render Server Components because you can pass JSX as props. In this case, `InspirationGenerator` receives `Copyright` as [children](/learn/passing-props-to-a-component#passing-jsx-as-children). However, the `InspirationGenerator` module never directly imports the `Copyright` module nor calls the component, all of that is done by `App`.
227
+
Client Components can render Server Components because you can pass JSX as props. In this case, `InspirationGenerator` receives `Copyright` as [children](/learn/passing-props-to-a-component#passing-jsx-as-children). However, the `InspirationGenerator` module never directly imports the `Copyright` module nor calls the component, all of that is done by `App`. In fact, the `Copyright` component is fully executed before `InspirationGenerator` starts rendering.
229
228
230
229
The takeaway is that a parent-child render relationship between components does not guarantee the same render environment.
231
230
232
231
</DeepDive>
233
232
234
233
### When to use `'use client'` {/*when-to-use-use-client*/}
235
234
236
-
With `'use client'`, you can determine what component usages will be Client Components. As Server Components are default, here is a brief overview of the advantages and limitations to Server Components to determine when you need to mark something as client rendered.
235
+
With `'use client'`, you can determine when components are Client Components. As Server Components are default, here is a brief overview of the advantages and limitations to Server Components to determine when you need to mark something as client rendered.
237
236
238
237
For simplicity, we talk about Server Components, but the same principles apply to all code in your app that is server run.
239
238
240
-
#### Advantages {/*advantages*/}
239
+
#### Advantages of Server Components {/*advantages*/}
241
240
* Server Components can reduce the amount of code sent and run by the client. Only client modules are bundled and evaluated by the client.
242
241
* Server Components benefit from running on the server. They can access the local filesystem and may experience low latency for data fetches and network requests.
243
242
244
-
#### Limitations {/*limitations*/}
243
+
#### Limitations of Server Components {/*limitations*/}
245
244
* Server Components cannot support interaction as event handlers must be registered and triggered by a client.
246
-
* The browser, as an example client, is responsible for delegating UI clicks to the appropriate `onClick` handler.
245
+
* For example, event handlers like `onClick` can only be defined in Client Components.
247
246
* Server Components cannot use most Hooks.
248
-
* When Server Components are rendered, they are conceptually resolved into instructions for the client to interpret and turn into UI primitives. This means that Server Components do not persist in memory after render and do not support re-rendering or state.
247
+
* When Server Components are rendered, their output is essentially a list of components for the client to render. Server Components do not persist in memory after render and cannot have their own state.
249
248
250
-
### Passing props from Server to Client Components {/*passing-props-from-server-to-client-components*/}
249
+
### Serializable types returned by Server Components {/*serializable-types*/}
251
250
252
251
As in any React app, parent components pass data to child components. As they are rendered in different environments, passing data from a Server Component to a Client Component requires extra consideration.
* [TypedArray](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray) and [ArrayBuffer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer)
* Plain [objects](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object), those created with [object initializers](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Object_initializer), with serializable properties
274
-
* Client or Server Components
271
+
* Plain [objects](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object): those created with [object initializers](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Object_initializer), with serializable properties
272
+
* Functions that are [server actions](/reference/react/use-server)
*[Functions](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function) that are not exported from client-marked modules or marked with [`'use server'`](/reference/react/use-server)
* Objects that are instances of any class (other than built-ins mentioned) or objects with [null-prototype](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object#null-prototype_objects)
279
+
* Objects that are instances of any class (other than the built-ins mentioned) or objects with [a nullprototype](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object#null-prototype_objects)
281
280
* Symbols not registered globally, ex. `Symbol('my new symbol')`
282
281
283
282
@@ -293,14 +292,16 @@ Notably, these are not supported:
For example, the parent component of the Client Component `CounterContainer` does not require `'use client'` as it is not interactive and does not use state. In addition, `CounterContainer` must be a Server Component as it reads from the local file system on the server. This is possible because Server Components, unlike Client Components, can be async functions.
324
+
For example, `Counter`'s parent component, `CounterContainer`, does not require `'use client'` as it is not interactive and does not use state. In addition, `CounterContainer` must be a Server Component as it reads from the local file system on the server, which is possible only in a Server Component.
324
325
325
-
There are also components that don't use any server or client-only features and can be agnostic to where they render. `FancyText` is an example of such a component.
326
+
There are also components that don't use any server or client-only features and can be agnostic to where they render. In our earlier example, `FancyText` is one such component.
326
327
327
328
```js
328
329
exportdefaultfunctionFancyText({title, text}) {
@@ -332,13 +333,15 @@ export default function FancyText({title, text}) {
332
333
}
333
334
```
334
335
335
-
In this case, it is discouraged to use the `'use client'` directive as it prematurely forces all component usages of `FancyText` to be rendered on the client, which comes at a performance cost. As demonstrated in the earlier Inspirations app example, `FancyText` is used as both a Server or Client Component, depending on where it is imported and used.
336
+
In this case, we don't add the `'use client'` directive, resulting in `FancyText`'s _output_ (rather than its source code) to be sent to the browser when referenced from a Server Component. As demonstrated in the earlier Inspirations app example, `FancyText` is used as both a Server or Client Component, depending on where it is imported and used.
337
+
338
+
But if `FancyText`'s HTML output was large relative to its source code (including dependencies), it might be more efficient to force it to always be a Client Component. Components that return a long SVG path string are one case where it may be more efficient to force a component to be a Client Component.
336
339
337
340
### Using client APIs {/*using-client-apis*/}
338
341
339
-
Your React app may use client-specific APIs which are dependent on your targeted client. For the browser, some example client APIs include web storage, audio and video manipulation, and device hardware, among [others](https://developer.mozilla.org/en-US/docs/Web/API).
342
+
Your React app may use client-specific APIs, such as the browser's APIs for web storage, audio and video manipulation, and device hardware, among [others](https://developer.mozilla.org/en-US/docs/Web/API).
340
343
341
-
In this example, the component uses [DOM APIs](https://developer.mozilla.org/en-US/docs/Glossary/DOM) to manipulate a [`canvas`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/canvas) element. Since those APIs are only available in the browser, it must be marked as a Client Component.
344
+
In this example, the component uses [DOM APIs](https://developer.mozilla.org/en-US/docs/Glossary/DOM) to manipulate a [`canvas`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/canvas) element. Since those APIs are only available in the browser, it must be marked as a Client Component.
342
345
343
346
```js
344
347
'use client';
@@ -350,26 +353,27 @@ export default function Circle() {
350
353
useLayoutEffect(() => {
351
354
constcanvas=ref.current;
352
355
constcontext=canvas.getContext('2d');
356
+
context.reset();
353
357
context.beginPath();
354
358
context.arc(100, 75, 50, 0, 2*Math.PI);
355
359
context.stroke();
356
360
});
357
-
return<canvas ref={ref} />
361
+
return<canvas ref={ref} />;
358
362
}
359
363
```
360
364
361
-
### Using React libraries {/*using-react-libraries*/}
365
+
### Using third-party libraries {/*using-third-party-libraries*/}
362
366
363
367
Often in a React app, you'll leverage third-party libraries to handle common UI patterns or logic.
364
368
365
-
These libraries may rely on component Hooks or client APIs. In these cases, you'll need to ensure you're using these libraries in Client Components. Depending on the nature of these libraries, this may mean adding a `'use client'` near the top of your module dependency tree – marking the majority of your React app as client-rendered.
366
-
367
-
Libraries that use any of the following React APIs must be marked as client-run:
369
+
These libraries may rely on component Hooks or client APIs. Third-party components that use any of the following React APIs must run on the client:
368
370
*[createContext](/reference/react/createContext)
369
371
*[`react`](/reference/react/hooks) and [`react-dom`](/reference/react-dom/hooks) Hooks, excluding [`use`](/reference/react/use) and [`useId`](/reference/react/useId)
* If they use client APIs, ex. DOM insertion or native platform views
374
376
377
+
If these libraries have been updated to be compatible with React Server Components, then they will already include `'use client'` markers of their own, allowing you to use them directly from your Server Components. If a library hasn't been updated, or if a component needs props like event handlers that can only be specified on the client, you may need to add your own Client Component file in between the third-party Client Component and your Server Component where you'd like to use it.
0 commit comments