Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rewrite "adding React to existing app" #992

Closed
wants to merge 21 commits into from
104 changes: 38 additions & 66 deletions content/docs/add-react-to-an-existing-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,87 +10,59 @@ You don't need to rewrite your app to start using React.

We recommend adding React to a small part of your application, such as an individual widget, so you can see if it works well for your use case.

While React [can be used](/docs/react-without-es6.html) without a build pipeline, we recommend setting it up so you can be more productive. A modern build pipeline typically consists of:

* A **package manager**, such as [Yarn](https://yarnpkg.com/) or [npm](https://www.npmjs.com/). It lets you take advantage of a vast ecosystem of third-party packages, and easily install or update them.
* A **bundler**, such as [webpack](https://webpack.js.org/) or [Browserify](http://browserify.org/). It lets you write modular code and bundle it together into small packages to optimize load time.
* A **compiler** such as [Babel](http://babeljs.io/). It lets you write modern JavaScript code that still works in older browsers.

### Installing React

>**Note:**
>
>Once installed, we strongly recommend setting up a [production build process](/docs/optimizing-performance.html#use-the-production-build) to ensure you're using the fast version of React in production.

We recommend using [Yarn](https://yarnpkg.com/) or [npm](https://www.npmjs.com/) for managing front-end dependencies. If you're new to package managers, the [Yarn documentation](https://yarnpkg.com/en/docs/getting-started) is a good place to get started.

To install React with Yarn, run:

```bash
yarn init
yarn add react react-dom
### 1. Add React [CDN links][cdn] to your HTML

```html
<script
crossorigin
src="https://unpkg.com/react@16/umd/react.production.min.js">
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's make these "development" versions at first, and add a 5th step that says "Before deploying, replace the React script tags with production versions"

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The last step should also say something "You probably already have a minification step for your JavaScript—don't forget to minify your component files too!"

</script>
<script
crossorigin
src="https://unpkg.com/react-dom@16/umd/react-dom.production.min.js">
</script>
```

To install React with npm, run:

```bash
npm init
npm install --save react react-dom
```

Both Yarn and npm download packages from the [npm registry](http://npmjs.com/).

> Note:
>
> To prevent potential incompatibilities, all react packages should use the same version. (This includes `react`, `react-dom`, `react-test-renderer`, etc.)

### Enabling ES6 and JSX

We recommend using React with [Babel](http://babeljs.io/) to let you use ES6 and JSX in your JavaScript code. ES6 is a set of modern JavaScript features that make development easier, and JSX is an extension to the JavaScript language that works nicely with React.

The [Babel setup instructions](https://babeljs.io/docs/setup/) explain how to configure Babel in many different build environments. Make sure you install [`babel-preset-react`](http://babeljs.io/docs/plugins/preset-react/#basic-setup-with-the-cli-) and [`babel-preset-env`](http://babeljs.io/docs/plugins/preset-env/) and enable them in your [`.babelrc` configuration](http://babeljs.io/docs/usage/babelrc/), and you're good to go.

### Hello World with ES6 and JSX

We recommend using a bundler like [webpack](https://webpack.js.org/) or [Browserify](http://browserify.org/), so you can write modular code and bundle it together into small packages to optimize load time.

The smallest React example looks like this:
### 2. Write your components

```js
import React from 'react';
import ReactDOM from 'react-dom';
// src/widget.js
class Widget extends React.Component() {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo: shouldn't have parens at the end

render() {
return <div>Hello, world!</div>;
}
}

ReactDOM.render(
<h1>Hello, world!</h1>,
document.getElementById('root')
<Widget />,
document.querySelector('.widget')
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this still looks too much like an SPA entry point. Maybe we could render the same component a few times to different nodes? e.g. three buttons

);
```

This code renders into a DOM element with the id of `root`, so you need `<div id="root"></div>` somewhere in your HTML file.
### 3. Compile with Babel
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we don't need babel to compile, we can require inline, the whole point of this piece is that we can use babel in a script:

// babel in a script

<script src="https://unpkg.com/babel-standalone@6.26.0/babel.js"></script>

// lower down

<script type="text/babel">

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's extremely slow - this is meant for people adding React to an actual app. If they are just trying React they should be referring to the Try React page.


Similarly, you can render a React component inside a DOM element somewhere inside your existing app written with any other JavaScript UI library.
[Babel][babel] is a tool that converts [JSX][jsx] and future JavaScript syntax into ES5 JavaScript compatible with older browsers.

[Learn more about integrating React with existing code.](/docs/integrating-with-other-libraries.html#integrating-with-other-view-libraries)
_Install `babel` with `yarn` or `npm`_

### A Complete Example

You can find step-by-step instructions detailing a basic implementation from scratch, including Babel and Webpack setup [here](https://medium.com/@JedaiSaboteur/creating-a-react-app-from-scratch-f3c693b84658).

### Development and Production Versions
```shell
npm install --global babel-cli babel-preset-react-app
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

react-app preset won't work if you don't explicitly specify NODE_ENV.

However we can add an entry point like babel-preset-react-app/prod to avoid messing with env variables.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also this won't work: Babel can't locate a global preset.

I think it'll have to be local installs.

```

By default, React includes many helpful warnings. These warnings are very useful in development.
_Example: compile files in `src` folder to `build`_

**However, they make the development version of React larger and slower so you should use the production version when you deploy the app.**
```shell
babel --presets=react-app src -d build
```

Learn [how to tell if your website is serving the right version of React](/docs/optimizing-performance.html#use-the-production-build), and how to configure the production build process most efficiently:
### 4. Add components to page

* [Creating a Production Build with Create React App](/docs/optimizing-performance.html#create-react-app)
* [Creating a Production Build with Single-File Builds](/docs/optimizing-performance.html#single-file-builds)
* [Creating a Production Build with Brunch](/docs/optimizing-performance.html#brunch)
* [Creating a Production Build with Browserify](/docs/optimizing-performance.html#browserify)
* [Creating a Production Build with Rollup](/docs/optimizing-performance.html#rollup)
* [Creating a Production Build with webpack](/docs/optimizing-performance.html#webpack)
```html
<script src="build/widget.js"></script>
```

### Using a CDN
<!-- Links: -->

If you don't want to use npm to manage client packages, the `react` and `react-dom` npm packages also provide single-file distributions in `umd` folders. See the [CDN](/docs/cdn-links.html) page for links.
[babel]: https://babeljs.io
[cdn]: /docs/cdn-links.html
[jsx]: /docs/introducing-jsx.html