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/learn/react-compiler.md
+48-98
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ title: React Compiler
3
3
---
4
4
5
5
<Intro>
6
-
This page will give you an introduction to the new experimental React Compiler and how to try it out successfully.
6
+
This page will give you an introduction to React Compiler and how to try it out successfully.
7
7
</Intro>
8
8
9
9
<Wip>
@@ -19,12 +19,28 @@ These docs are still a work in progress. More documentation is available in the
19
19
</YouWillLearn>
20
20
21
21
<Note>
22
-
React Compiler is a new experimental compiler that we've open sourced to get early feedback from the community. It still has rough edges and is not yet fully ready for production.
22
+
React Compiler is a new compiler currently in Beta, that we've open sourced to get early feedback from the community. While it has been used in production at companies like Meta, rolling out the compiler to production for your app will depend on the health of your codebase and how well you’ve followed the [Rules of React](/reference/rules).
23
+
24
+
The latest Beta release can be found with the `@beta` tag, and daily experimental releases with `@experimental`.
23
25
</Note>
24
26
25
-
React Compiler is a new experimental compiler that we've open sourced to get early feedback from the community. It is a build-time only tool that automatically optimizes your React app. It works with plain JavaScript, and understands the [Rules of React](/reference/rules), so you don't need to rewrite any code to use it.
27
+
React Compiler is a new compiler that we've open sourced to get early feedback from the community. It is a build-time only tool that automatically optimizes your React app. It works with plain JavaScript, and understands the [Rules of React](/reference/rules), so you don't need to rewrite any code to use it.
28
+
29
+
The compiler also includes an [eslint plugin](#installing-eslint-plugin-react-compiler) that surfaces the analysis from the compiler right in your editor. **We strongly recommend everyone use the linter today.** The linter does not require that you have the compiler installed, so you can use it even if you are not ready to try out the compiler.
30
+
31
+
The compiler is currently released as `beta`, and is available to try out on React 17+ apps and libraries. To install the Beta:
26
32
27
-
The compiler also includes an [eslint plugin](#installing-eslint-plugin-react-compiler) that surfaces the analysis from the compiler right in your editor. The plugin runs independently of the compiler and can be used even if you aren't using the compiler in your app. We recommend all React developers to use this eslint plugin to help improve the quality of your codebase.
If you are not using React 19 yet, please see [the section below](#using-react-compiler-with-react-17-or-18) for further instructions.
28
44
29
45
### What does the compiler do? {/*what-does-the-compiler-do*/}
30
46
@@ -94,19 +110,9 @@ However, if `expensivelyProcessAReallyLargeArrayOfObjects` is truly an expensive
94
110
So if `expensivelyProcessAReallyLargeArrayOfObjects` was used in many different components, even if the same exact items were passed down, that expensive calculation would be run repeatedly. We recommend [profiling](https://react.dev/reference/react/useMemo#how-to-tell-if-a-calculation-is-expensive) first to see if it really is that expensive before making code more complicated.
95
111
</DeepDive>
96
112
97
-
### What does the compiler assume? {/*what-does-the-compiler-assume*/}
98
-
99
-
React Compiler assumes that your code:
100
-
101
-
1. Is valid, semantic JavaScript
102
-
2. Tests that nullable/optional values and properties are defined before accessing them (for example, by enabling [`strictNullChecks`](https://www.typescriptlang.org/tsconfig/#strictNullChecks) if using TypeScript), i.e., `if (object.nullableProperty) { object.nullableProperty.foo }` or with optional-chaining `object.nullableProperty?.foo`
103
-
3. Follows the [Rules of React](https://react.dev/reference/rules)
104
-
105
-
React Compiler can verify many of the Rules of React statically, and will safely skip compilation when it detects an error. To see the errors we recommend also installing [eslint-plugin-react-compiler](https://www.npmjs.com/package/eslint-plugin-react-compiler).
106
-
107
113
### Should I try out the compiler? {/*should-i-try-out-the-compiler*/}
108
114
109
-
Please note that the compiler is still experimental and has many rough edges. While it has been used in production at companies like Meta, rolling out the compiler to production for your app will depend on the health of your codebase and how well you've followed the [Rules of React](/reference/rules).
115
+
Please note that the compiler is still in Beta and has many rough edges. While it has been used in production at companies like Meta, rolling out the compiler to production for your app will depend on the health of your codebase and how well you've followed the [Rules of React](/reference/rules).
110
116
111
117
**You don't have to rush into using the compiler now. It's okay to wait until it reaches a stable release before adopting it.** However, we do appreciate trying it out in small experiments in your apps so that you can [provide feedback](#reporting-issues) to us to help make the compiler better.
112
118
@@ -119,7 +125,7 @@ In addition to these docs, we recommend checking the [React Compiler Working Gro
119
125
Prior to installing the compiler, you can first check to see if your codebase is compatible:
120
126
121
127
<TerminalBlock>
122
-
npx react-compiler-healthcheck@experimental
128
+
npx react-compiler-healthcheck@beta
123
129
</TerminalBlock>
124
130
125
131
This script will:
@@ -141,7 +147,7 @@ Found no usage of incompatible libraries.
141
147
React Compiler also powers an eslint plugin. The eslint plugin can be used **independently** of the compiler, meaning you can use the eslint plugin even if you don't use the compiler.
In rare cases, you can also configure the compiler to run in "opt-in" mode using the `compilationMode: "annotation"` option. This makes it so the compiler will only compile components and hooks annotated with a `"use memo"` directive. Please note that the `annotation` mode is a temporary one to aid early adopters, and that we don't intend for the `"use memo"` directive to be used for the long term.
180
-
181
-
```js {2,7}
182
-
constReactCompilerConfig= {
183
-
compilationMode:"annotation",
184
-
};
185
+
When you have more confidence with rolling out the compiler, you can expand coverage to other directories as well and slowly roll it out to your whole app.
185
186
186
-
// src/app.jsx
187
-
exportdefaultfunctionApp() {
188
-
"use memo";
189
-
// ...
190
-
}
191
-
```
187
+
#### New projects {/*new-projects*/}
192
188
193
-
When you have more confidence with rolling out the compiler, you can expand coverage to other directories as well and slowly roll it out to your whole app.
189
+
If you're starting a new project, you can enable the compiler on your entire codebase, which is the default behavior.
194
190
195
191
### Using React Compiler with React 17 or 18 {/*using-react-compiler-with-react-17-or-18*/}
196
192
197
193
React Compiler works best with React 19 RC. If you are unable to upgrade, you can install the extra `react-compiler-runtime` package which will allow the compiled code to run on versions prior to 19. However, note that the minimum supported version is 17.
198
194
199
195
<TerminalBlock>
200
-
npm install react-compiler-runtime@experimental
196
+
npm install react-compiler-runtime@beta
201
197
</TerminalBlock>
202
198
203
199
You should also add the correct `target` to your compiler config, where `target` is the major version of React you are targeting:
@@ -217,16 +213,22 @@ module.exports = function () {
217
213
};
218
214
```
219
215
220
-
#### New projects {/*new-projects*/}
216
+
###Using the compiler on libraries {/*using-the-compiler-on-libraries*/}
221
217
222
-
If you're starting a new project, you can enable the compiler on your entire codebase, which is the default behavior.
218
+
React Compiler can also be used to compile libraries. Because React Compiler needs to run on the original source code prior to any code transformations, it is not possible for an application's build pipeline to compile the libraries they use. Hence, our recommendation is for library maintainers to independently compile and test their libraries with the compiler, and ship compiled code to npm.
219
+
220
+
Because your code is pre-compiled, users of your library will not need to have the compiler enabled in order to benefit from the automatic memoization applied to your library. If your library targets apps not yet on React 19, specify a minimum [`target` and add `react-compiler-runtime` as a direct dependency](#using-react-compiler-with-react-17-or-18). The runtime package will use the correct implementation of APIs depending on the application's version, and polyfill the missing APIs if necessary.
221
+
222
+
Library code can often require more complex patterns and usage of escape hatches. For this reason, we recommend ensuring that you have sufficient testing in order to identify any issues that might arise from using the compiler on your library. If you identify any issues, you can always opt-out the specific components or hooks with the [`'use no memo'` directive](#something-is-not-working-after-compilation).
223
+
224
+
Similarly to apps, it is not necessary to fully compile 100% of your components or hooks to see benefits in your library. A good starting point might be to identify the most performance sensitive parts of your library and ensuring that they don't break the [Rules of React](/reference/rules), which you can use `eslint-plugin-react-compiler` to identify.
A community Webpack loader is [now available here](https://github.com/SukkaW/react-compiler-webpack).
374
314
375
315
### Expo {/*usage-with-expo*/}
376
316
@@ -394,6 +334,16 @@ To report issues, please first create a minimal repro on the [React Compiler Pla
394
334
395
335
You can also provide feedback in the React Compiler Working Group by applying to be a member. Please see [the README for more details on joining](https://github.com/reactwg/react-compiler).
396
336
337
+
### What does the compiler assume? {/*what-does-the-compiler-assume*/}
338
+
339
+
React Compiler assumes that your code:
340
+
341
+
1. Is valid, semantic JavaScript.
342
+
2. Tests that nullable/optional values and properties are defined before accessing them (for example, by enabling [`strictNullChecks`](https://www.typescriptlang.org/tsconfig/#strictNullChecks) if using TypeScript), i.e., `if (object.nullableProperty) { object.nullableProperty.foo }` or with optional-chaining `object.nullableProperty?.foo`.
343
+
3. Follows the [Rules of React](https://react.dev/reference/rules).
344
+
345
+
React Compiler can verify many of the Rules of React statically, and will safely skip compilation when it detects an error. To see the errors we recommend also installing [eslint-plugin-react-compiler](https://www.npmjs.com/package/eslint-plugin-react-compiler).
346
+
397
347
### How do I know my components have been optimized? {/*how-do-i-know-my-components-have-been-optimized*/}
398
348
399
349
[React Devtools](/learn/react-developer-tools) (v5.0+) has built-in support for React Compiler and will display a "Memo ✨" badge next to components that have been optimized by the compiler.
0 commit comments