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
Copy file name to clipboardExpand all lines: src/content/reference/react/use-client.md
+6-5Lines changed: 6 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -58,7 +58,7 @@ As dependencies of `RichTextEditor`, `formatDate` and `Button` will also be eval
58
58
59
59
In a React app, components are often split into separate files, or [modules](/learn/importing-and-exporting-components#exporting-and-importing-a-component).
60
60
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.
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.
62
62
63
63
To better illustrate this, consider the following React Server Components app.
64
64
@@ -145,7 +145,7 @@ export default [
145
145
146
146
</Sandpack>
147
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.
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
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'.">
151
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.
@@ -237,7 +237,7 @@ With `'use client'`, you can determine when components are Client Components. As
237
237
For simplicity, we talk about Server Components, but the same principles apply to all code in your app that is server run.
238
238
239
239
#### Advantages of Server Components {/*advantages*/}
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.
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.
241
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.
242
242
243
243
#### Limitations of Server Components {/*limitations*/}
@@ -269,7 +269,7 @@ Serializable props include:
269
269
* [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
272
-
* Functions that are [Server Actions](/reference/react/use-server)
272
+
* Functions that are [server actions](/reference/react/use-server)
As `Counter` requires both the `useState`Hook and event handlers to increment or decrement the value, this component must be a Client Component and will require a `'use client'` directive at the top.
310
+
As `Counter` requires both the `useState`hook and event handlers to increment or decrement the value, this component must be a Client Component and will require a `'use client'` directive at the top.
311
311
312
312
In contrast, a component that renders UI without interaction will not need to be a Client Component.
313
313
@@ -377,3 +377,4 @@ These libraries may rely on component Hooks or client APIs. Third-party componen
377
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.
Copy file name to clipboardExpand all lines: src/content/reference/react/use-server.md
+26-24Lines changed: 26 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,7 +25,7 @@ canary: true
25
25
26
26
### `'use server'` {/*use-server*/}
27
27
28
-
Add `'use server'` at the top of an async function body to mark the function as callable by the client. We call these functions _Server Actions_.
28
+
Add `'use server'` at the top of an async function body to mark the function as callable by the client. We call these functions _server actions_.
29
29
30
30
```js {2}
31
31
asyncfunctionaddToCart(data) {
@@ -34,38 +34,38 @@ async function addToCart(data) {
34
34
}
35
35
```
36
36
37
-
When calling a Server Action on the client, it will make a network request to the server that includes a serialized copy of any arguments passed. If the Server Action returns a value, that value will be serialized and returned to the client.
37
+
When calling a server action on the client, it will make a network request to the server that includes a serialized copy of any arguments passed. If the server action returns a value, that value will be serialized and returned to the client.
38
38
39
-
Instead of individually marking functions with `'use server'`, you can add the directive to the top of a file to mark all exports within that file as Server Actions that can be used anywhere, including imported in client code.
39
+
Instead of individually marking functions with `'use server'`, you can add the directive to the top of a file to mark all exports within that file as server actions that can be used anywhere, including imported in client code.
40
40
41
41
#### Caveats {/*caveats*/}
42
42
*`'use server'` must be at the very beginning of their function or module; above any other code including imports (comments above directives are OK). They must be written with single or double quotes, not backticks.
43
-
*`'use server'` can only be used in server-side files. The resulting Server Actions can be passed to Client Components through props. See supported [types for serialization](#serializable-parameters-and-return-values).
44
-
* To import a Server Action from [client code](/reference/react/use-client), the directive must be used on a module level.
43
+
*`'use server'` can only be used in server-side files. The resulting server actions can be passed to Client Components through props. See supported [types for serialization](#serializable-parameters-and-return-values).
44
+
* To import a server action from [client code](/reference/react/use-client), the directive must be used on a module level.
45
45
* Because the underlying network calls are always asynchronous, `'use server'` can only be used on async functions.
46
-
* Always treat arguments to Server Actions as untrusted input and authorize any mutations. See [security considerations](#security).
47
-
* Server Actions should be called in a [transition](/reference/react/useTransition). Server Actions passed to [`<form action>`](/reference/react-dom/components/form#props) or [`formAction`](/reference/react-dom/components/input#props) will automatically be called in a transition.
48
-
* Server Actions are designed for mutations that update server-side state; they are not recommended for data fetching. Accordingly, frameworks implementing Server Actions typically process one action at a time and do not have a way to cache the return value.
46
+
* Always treat arguments to server actions as untrusted input and authorize any mutations. See [security considerations](#security).
47
+
* Server actions should be called in a [transition](/reference/react/useTransition). Server actions passed to [`<form action>`](/reference/react-dom/components/form#props) or [`formAction`](/reference/react-dom/components/input#props) will automatically be called in a transition.
48
+
* Server actions are designed for mutations that update server-side state; they are not recommended for data fetching. Accordingly, frameworks implementing server actions typically process one action at a time and do not have a way to cache the return value.
49
49
50
50
### Security considerations {/*security*/}
51
51
52
-
Arguments to Server Actions are fully client-controlled. For security, always treat them as untrusted input, and make sure to validate and escape arguments as appropriate.
52
+
Arguments to server actions are fully client-controlled. For security, always treat them as untrusted input, and make sure to validate and escape arguments as appropriate.
53
53
54
-
In any Server Action, make sure to validate that the logged-in user is allowed to perform that action.
54
+
In any server action, make sure to validate that the logged-in user is allowed to perform that action.
55
55
56
56
<Wip>
57
57
58
-
To prevent sending sensitive data from a Server Action, there are experimental taint APIs to prevent unique values and objects from being passed to client code.
58
+
To prevent sending sensitive data from a server action, there are experimental taint APIs to prevent unique values and objects from being passed to client code.
59
59
60
60
See [experimental_taintUniqueValue](/reference/react/experimental_taintUniqueValue) and [experimental_taintObjectReference](/reference/react/experimental_taintObjectReference).
61
61
62
62
</Wip>
63
63
64
64
### Serializable arguments and return values {/*serializable-parameters-and-return-values*/}
65
65
66
-
As client code calls the Server Action over the network, any arguments passed will need to be serializable.
66
+
As client code calls the server action over the network, any arguments passed will need to be serializable.
67
67
68
-
Here are supported types for Server Action arguments:
68
+
Here are supported types for server action arguments:
* 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
* Objects that are instances of any class (other than the built-ins mentioned) or objects with [a null prototype](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object#null-prototype_objects)
95
95
* Symbols not registered globally, ex. `Symbol('my new symbol')`
@@ -100,9 +100,9 @@ Supported serializable return values are the same as [serializable props](/refer
100
100
101
101
## Usage {/*usage*/}
102
102
103
-
### Server Actions in forms {/*server-actions-in-forms*/}
103
+
### Server actions in forms {/*server-actions-in-forms*/}
104
104
105
-
The most common use case of Server Actions will be calling server functions that mutate data. On the browser, the [HTML form element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form) is the traditional approach for a user to submit a mutation. With React Server Components, React introduces first-class support for Server Actions in [forms](/reference/react-dom/components/form).
105
+
The most common use case of server actions will be calling server functions that mutate data. On the browser, the [HTML form element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form) is the traditional approach for a user to submit a mutation. With React Server Components, React introduces first-class support for server actions in [forms](/reference/react-dom/components/form).
106
106
107
107
Here is a form that allows a user to request a username.
108
108
@@ -123,15 +123,16 @@ export default App() {
123
123
}
124
124
```
125
125
126
-
In this example `requestUsername` is a Server Action passed to a `<form>`. When a user submits this form, there is a network request to the server function `requestUsername`. When calling a Server Action in a form, React will supply the form's <CodeStepstep={1}>[FormData](https://developer.mozilla.org/en-US/docs/Web/API/FormData)</CodeStep> as the first argument to the Server Action.
126
+
In this example `requestUsername` is a server action passed to a `<form>`. When a user submits this form, there is a network request to the server function `requestUsername`. When calling a server action in a form, React will supply the form's <CodeStepstep={1}>[FormData](https://developer.mozilla.org/en-US/docs/Web/API/FormData)</CodeStep> as the first argument to the server action.
127
127
128
-
By passing a Server Action to the form `action`, React can [progressively enhance](https://developer.mozilla.org/en-US/docs/Glossary/Progressive_Enhancement) the form. This means that forms can be submitted before the JavaScript bundle is loaded.
128
+
By passing a server action to the form `action`, React can [progressively enhance](https://developer.mozilla.org/en-US/docs/Glossary/Progressive_Enhancement) the form. This means that forms can be submitted before the JavaScript bundle is loaded.
129
129
130
130
#### Handling return values in forms {/*handling-return-values*/}
131
131
132
132
In the username request form, there might be the chance that a username is not available. `requestUsername` should tell us if it fails or not.
133
133
134
-
To update the UI based on the result of a Server Action while supporting progressive enhancement, use [`useFormState`](/reference/react-dom/hooks/useFormState).
134
+
135
+
To update the UI based on the result of a server action while supporting progressive enhancement, use [`useFormState`](/reference/react-dom/hooks/useFormState).
135
136
136
137
```js
137
138
// requestUsername.js
@@ -171,11 +172,11 @@ function UsernameForm() {
171
172
172
173
Note that like most Hooks, `useFormState` can only be called in <CodeStepstep={1}>[client code](/reference/react/use-client)</CodeStep>.
173
174
174
-
### Calling a Server Action outside of `<form>` {/*calling-a-server-action-outside-of-form*/}
175
+
### Calling a server action outside of `<form>` {/*calling-a-server-action-outside-of-form*/}
175
176
176
-
Server Actions are exposed server endpoints and can be called anywhere in client code.
177
+
Server actions are exposed server endpoints and can be called anywhere in client code.
177
178
178
-
When using a Server Action outside of a [form](/reference/react-dom/components/form), call the Server Action in a [transition](/reference/react/useTransition), which allows you to display a loading indicator, show [optimistic state updates](/reference/react/useOptimistic), and handle unexpected errors. Forms will automatically wrap Server Actions in transitions.
179
+
When using a server action outside of a [form](/reference/react-dom/components/form), call the server action in a [transition](/reference/react/useTransition), which allows you to display a loading indicator, show [optimistic state updates](/reference/react/useOptimistic), and handle unexpected errors. Forms will automatically wrap server actions in transitions.
0 commit comments