Skip to content

Commit 879589e

Browse files
authored
Merge branch 'master' into concurrent-mode-patterns
2 parents afa663a + 5a598bd commit 879589e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

59 files changed

+6383
-3536
lines changed

.github/PULL_REQUEST_TEMPLATE.md

+9
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
1+
Note to Hacktoberfest 🎃 participants:
12

3+
While we appreciate the enthusiasm, we are experiencing a high volume of drive-by pull requests (one-line changes, README tweaks, etc.). Please remember that hundreds of people are subscribed to this repo and will receive notifications for these PRs. Spam submissions will be closed and won't count towards your Hacktoberfest goals.
24

5+
Please search for issues tagged [`good first issue`][gfi] or [`hacktoberfest`][hacktoberfest] to find things to work on.
6+
7+
You can also search [all of GitHub][all].
8+
9+
[gfi]: https://github.com/reactjs/reactjs.org/issues?q=is%3Aissue+is%3Aopen+label%3A"good+first+issue"
10+
[hacktoberfest]: https://github.com/reactjs/reactjs.org/issues?q=is%3Aissue+is%3Aopen+label%3A"good+first+issue"
11+
[all]: https://github.com/search?q=is%3Aissue+hacktoberfest
312
<!--
413
514
Thank you for the PR! Contributors like you keep React awesome!

content/authors.yml

+7-1
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,9 @@ kmeht:
5252
LoukaN:
5353
name: Lou Husson
5454
url: https://twitter.com/loukan42
55+
lunaruan:
56+
name: Luna Ruan
57+
url: https://twitter.com/lunaruan
5558
matthewjohnston4:
5659
name: Matthew Johnston
5760
url: https://github.com/matthewathome
@@ -61,6 +64,9 @@ nhunzaker:
6164
petehunt:
6265
name: Pete Hunt
6366
url: https://twitter.com/floydophone
67+
rachelnabors:
68+
name: Rachel Nabors
69+
url: https://twitter.com/rachelnabors
6470
schrockn:
6571
name: Nick Schrock
6672
url: https://twitter.com/schrockn
@@ -93,4 +99,4 @@ zpao:
9399
url: https://twitter.com/zpao
94100
tomocchino:
95101
name: Tom Occhino
96-
url: https://twitter.com/tomocchino
102+
url: https://twitter.com/tomocchino

content/blog/2019-08-15-new-react-devtools.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ It also offers full support for React Hooks, including inspecting nested objects
2323
* `16.x`: Supported
2424

2525
**`react-native`**
26-
* `0`-`0.61`: Not supported
27-
* `0.62`: Will be supported (when 0.62 is released)
26+
* `0`-`0.61.x`: Not supported
27+
* `0.62`: Supported
2828

2929
## How do I get the new DevTools? {#how-do-i-get-the-new-devtools}
3030

content/blog/2020-08-10-react-v17-rc.md

+375
Large diffs are not rendered by default.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,266 @@
1+
---
2+
title: "Introducing the New JSX Transform"
3+
author: [lunaruan]
4+
---
5+
6+
Although React 17 [doesn't contain new features](/blog/2020/08/10/react-v17-rc.html), it will provide support for a new version of the JSX transform. In this post, we will describe what it is and how to try it.
7+
8+
## What's a JSX Transform? {#whats-a-jsx-transform}
9+
10+
Browsers don't understand JSX out of the box, so most React users rely on a compiler like Babel or TypeScript to **transform JSX code into regular JavaScript**. Many preconfigured toolkits like Create React App or Next.js also include a JSX transform under the hood.
11+
12+
Together with the React 17 release, we've wanted to make a few improvements to the JSX transform, but we didn't want to break existing setups. This is why we [worked with Babel](https://babeljs.io/blog/2020/03/16/7.9.0#a-new-jsx-transform-11154httpsgithubcombabelbabelpull11154) to **offer a new, rewritten version of the JSX transform** for people who would like to upgrade.
13+
14+
Upgrading to the new transform is completely optional, but it has a few benefits:
15+
16+
* With the new transform, you can **use JSX without importing React**.
17+
* Depending on your setup, its compiled output may **slightly improve the bundle size**.
18+
* It will enable future improvements that **reduce the number of concepts** you need to learn React.
19+
20+
**This upgrade will not change the JSX syntax and is not required.** The old JSX transform will keep working as usual, and there are no plans to remove the support for it.
21+
22+
23+
[React 17 RC](/blog/2020/08/10/react-v17-rc.html) already includes support for the new transform, so go give it a try! To make it easier to adopt, after React 17 is released, we also plan to backport its support to React 16.x, React 15.x, and React 0.14.x. You can find the upgrade instructions for different tools [below](#how-to-upgrade-to-the-new-jsx-transform).
24+
25+
Now let's take a closer look at the differences between the old and the new transform.
26+
27+
## What’s Different in the New Transform? {#whats-different-in-the-new-transform}
28+
29+
When you use JSX, the compiler transforms it into React function calls that the browser can understand. **The old JSX transform** turned JSX into `React.createElement(...)` calls.
30+
31+
For example, let's say your source code looks like this:
32+
33+
```js
34+
import React from 'react';
35+
36+
function App() {
37+
return <h1>Hello World</h1>;
38+
}
39+
```
40+
41+
Under the hood, the old JSX transform turns it into regular JavaScript:
42+
43+
```js
44+
import React from 'react';
45+
46+
function App() {
47+
return React.createElement('h1', null, 'Hello world');
48+
}
49+
```
50+
51+
>Note
52+
>
53+
>**Your source code doesn't need to change in any way.** We're describing how the JSX transform turns your JSX source code into the JavaScript code a browser can understand.
54+
55+
However, this is not perfect:
56+
57+
* Because JSX compiled into `React.createElement`, `React` needed to be in scope if you use JSX.
58+
* There are some [performance improvements and simplifications](https://github.com/reactjs/rfcs/blob/createlement-rfc/text/0000-create-element-changes.md#motivation) that `React.createElement` does not allow.
59+
60+
To solve these issues, React 17 introduces two new entry points to the React package that are intended to only be used by compilers like Babel and TypeScript. Instead of transforming JSX to `React.createElement`, **the new JSX transform** automatically imports special functions from those new entry points in the React package and calls them.
61+
62+
Let's say that your source code looks like this:
63+
64+
```js
65+
function App() {
66+
return <h1>Hello World</h1>;
67+
}
68+
```
69+
70+
This is what the new JSX transform compiles it to:
71+
72+
```js
73+
// Inserted by a compiler (don't import it yourself!)
74+
import {jsx as _jsx} from 'react/jsx-runtime';
75+
76+
function App() {
77+
return _jsx('h1', { children: 'Hello world' });
78+
}
79+
```
80+
81+
Note how our original code **did not need to import React** to use JSX anymore! (But we would still need to import React in order to use Hooks or other exports that React provides.)
82+
83+
**This change is fully compatible with all of the existing JSX code**, so you won't have to change your components. If you're curious, you can check out the [technical RFC](https://github.com/reactjs/rfcs/blob/createlement-rfc/text/0000-create-element-changes.md#detailed-design) for more details about how the new transform works.
84+
85+
> Note
86+
>
87+
> The functions inside `react/jsx-runtime` and `react/jsx-dev-runtime` must only be used by the compiler transform. If you need to manually create elements in your code, you should keep using `React.createElement`. It will continue to work and is not going away.
88+
89+
## How to Upgrade to the New JSX Transform {#how-to-upgrade-to-the-new-jsx-transform}
90+
91+
If you aren't ready to upgrade to the new JSX transform or if you are using JSX for another library, don't worry. The old transform will not be removed and will continue to be supported.
92+
93+
If you want to upgrade, you will need two things:
94+
95+
* **A version of React that supports the new transform** (currently, only [React 17 RC](/blog/2020/08/10/react-v17-rc.html) supports it, but after React 17.0 has been released, we plan to make additional compatible releases for 0.14.x, 15.x, and 16.x).
96+
* **A compatible compiler** (see instructions for different tools below).
97+
98+
Since the new JSX transform doesn't require React to be in scope, [we've also prepared an automated script](#removing-unused-react-imports) that will remove the unnecessary imports from your codebase.
99+
100+
### Create React App {#create-react-app}
101+
102+
Create React App support [has been added](https://github.com/facebook/create-react-app/pull/9645) and will be available in the [upcoming v4.0 release](https://gist.github.com/iansu/4fab7a9bfa5fa6ebc87a908c62f5340b) which is currently in beta testing.
103+
104+
### Next.js {#nextjs}
105+
106+
Next.js [v9.5.3](https://github.com/vercel/next.js/releases/tag/v9.5.3)+ uses the new transform for compatible React versions.
107+
108+
### Gatsby {#gatsby}
109+
110+
Gatsby [v2.24.5](https://github.com/gatsbyjs/gatsby/blob/master/packages/gatsby/CHANGELOG.md#22452-2020-08-28)+ uses the new transform for compatible React versions.
111+
112+
>Note
113+
>
114+
>If you get [this Gatsby error](https://github.com/gatsbyjs/gatsby/issues/26979) after upgrading to React `17.0.0-rc.2`, run `npm update` to fix it.
115+
116+
### Manual Babel Setup {#manual-babel-setup}
117+
118+
Support for the new JSX transform is available in Babel [v7.9.0](https://babeljs.io/blog/2020/03/16/7.9.0) and above.
119+
120+
First, you'll need to update to the latest Babel and plugin transform.
121+
122+
If you are using `@babel/plugin-transform-react-jsx`:
123+
124+
```bash
125+
# for npm users
126+
npm update @babel/core @babel/plugin-transform-react-jsx
127+
```
128+
129+
```bash
130+
# for yarn users
131+
yarn upgrade @babel/core @babel/plugin-transform-react-jsx
132+
```
133+
134+
If you are using `@babel/preset-react`:
135+
136+
```bash
137+
# for npm users
138+
npm update @babel/core @babel/preset-react
139+
```
140+
141+
```bash
142+
# for yarn users
143+
yarn upgrade @babel/core @babel/preset-react
144+
```
145+
146+
Currently, the old transform (`"runtime": "classic"`) is the default option. To enable the new transform, you can pass `{"runtime": "automatic"}` as an option to `@babel/plugin-transform-react-jsx` or `@babel/preset-react`:
147+
148+
```js
149+
// If you are using @babel/preset-react
150+
{
151+
"presets": [
152+
["@babel/preset-react", {
153+
"runtime": "automatic"
154+
}]
155+
]
156+
}
157+
```
158+
159+
```js
160+
// If you're using @babel/plugin-transform-react-jsx
161+
{
162+
"plugins": [
163+
["@babel/plugin-transform-react-jsx", {
164+
"runtime": "automatic"
165+
}]
166+
]
167+
}
168+
```
169+
170+
Starting from Babel 8, `"automatic"` will be the default runtime for both plugins. For more information, check out the Babel documentation for [@babel/plugin-transform-react-jsx](https://babeljs.io/docs/en/babel-plugin-transform-react-jsx) and [@babel/preset-react](https://babeljs.io/docs/en/babel-preset-react).
171+
172+
> Note
173+
>
174+
> If you use JSX with a library other than React, you can use [the `importSource` option](https://babeljs.io/docs/en/babel-preset-react#importsource) to import from that library instead -- as long as it provides the necessary entry points. Alternatively, you can keep using the classic transform which will continue to be supported.
175+
176+
### ESLint {#eslint}
177+
178+
If you are using [eslint-plugin-react](https://github.com/yannickcr/eslint-plugin-react), the `react/jsx-uses-react` and `react/react-in-jsx-scope` rules are no longer necessary and can be turned off or removed.
179+
180+
```js
181+
{
182+
// ...
183+
"rules": {
184+
// ...
185+
"react/jsx-uses-react": "off",
186+
"react/react-in-jsx-scope": "off"
187+
}
188+
}
189+
```
190+
191+
### TypeScript {#typescript}
192+
193+
TypeScript supports the JSX transform in [v4.1 beta](https://devblogs.microsoft.com/typescript/announcing-typescript-4-1-beta/#jsx-factories).
194+
195+
### Flow {#flow}
196+
197+
Flow supports the new JSX transform in [v0.126.0](https://github.com/facebook/flow/releases/tag/v0.126.0) and up.
198+
199+
## Removing Unused React Imports {#removing-unused-react-imports}
200+
201+
Because the new JSX transform will automatically import the necessary `react/jsx-runtime` functions, React will no longer need to be in scope when you use JSX. This might lead to unused React imports in your code. It doesn't hurt to keep them, but if you'd like to remove them, we recommend running a [“codemod”](https://medium.com/@cpojer/effective-javascript-codemods-5a6686bb46fb) script to remove them automatically:
202+
203+
```bash
204+
cd your_project
205+
npx react-codemod update-react-imports
206+
```
207+
208+
>Note
209+
>
210+
>If you're getting errors when running the codemod, try specifying a different JavaScript dialect when `npx react-codemod update-react-imports` asks you to choose one. In particular, at this moment the "JavaScript with Flow" setting supports newer syntax than the "JavaScript" setting even if you don't use Flow. [File an issue](https://github.com/reactjs/react-codemod/issues) if you run into problems.
211+
>
212+
>Keep in mind that the codemod output will not always match your project's coding style, so you might want to run [Prettier](https://prettier.io/) after the codemod finishes for consistent formatting.
213+
214+
215+
Running this codemod will:
216+
217+
* Remove all unused React imports as a result of upgrading to the new JSX transform.
218+
* Change all default React imports (i.e. `import React from "react"`) to destructured named imports (ex. `import { useState } from "react"`) which is the preferred style going into the future. This codemod **will not** affect the existing namespace imports (i.e. `import * as React from "react"`) which is also a valid style. The default imports will keep working in React 17, but in the longer term we encourage moving away from them.
219+
220+
For example,
221+
222+
```js
223+
import React from 'react';
224+
225+
function App() {
226+
return <h1>Hello World</h1>;
227+
}
228+
```
229+
230+
will be replaced with
231+
232+
```js
233+
function App() {
234+
return <h1>Hello World</h1>;
235+
}
236+
```
237+
238+
If you use some other import from React — for example, a Hook — then the codemod will convert it to a named import.
239+
240+
For example,
241+
242+
```js
243+
import React from 'react';
244+
245+
function App() {
246+
const [text, setText] = React.useState('Hello World');
247+
return <h1>{text}</h1>;
248+
}
249+
```
250+
251+
will be replaced with
252+
253+
```js
254+
import { useState } from 'react';
255+
256+
function App() {
257+
const [text, setText] = useState('Hello World');
258+
return <h1>{text}</h1>;
259+
}
260+
```
261+
262+
In addition to cleaning up unused imports, this will also help you prepare for a future major version of React (not React 17) which will support ES Modules and not have a default export.
263+
264+
## Thanks {#thanks}
265+
266+
We'd like to thank Babel, TypeScript, Create React App, Next.js, Gatsby, ESLint, and Flow maintainers for their help implementing and integrating the new JSX transform. We also want to thank the React community for their feedback and discussion on the related [technical RFC](https://github.com/reactjs/rfcs/pull/107).

0 commit comments

Comments
 (0)