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
121 changes: 61 additions & 60 deletions content/docs/add-react-to-an-existing-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,91 +6,92 @@ prev: add-react-to-a-new-app.html
next: cdn-links.html
---

You don't need to rewrite your app to start using React.
Use as little, or as much of React as you need.

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 you could [create a single-page app](/docs/add-react-to-a-new-app.html) with React, **the vast majority of the websites aren't, and don't need to be single-page apps**.

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:
React has always been designed for progressive adoption, and **you can use as little or as much of React as you need**. Quite often, people only want to add some "sprinkles of interactivity" to an existing page, and React components are a great tool for that.

* 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.
In some cases, [more parts of the page become driven by React over time](https://www.youtube.com/watch?v=BF58ZJ1ZQxY), but in others React stays as a flexible and unopinionated tool alongside the existing markup and code.

### Installing React
### 1. Add React [CDN links](/docs/cdn-links.html) to your HTML

>**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
```html
<script
crossorigin
src="https://unpkg.com/react@16/umd/react.development.js">
</script>
<script
crossorigin
src="https://unpkg.com/react-dom@16/umd/react-dom.development.js">
</script>
```

To install React with npm, run:
### 2. Write your components

```bash
npm init
npm install --save react react-dom
```js
// src/button.js

class Button extends React.Component {
Copy link
Contributor

Choose a reason for hiding this comment

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

prefer to use functional components unless you have a need for classes

Copy link
Collaborator Author

@alexkrolick alexkrolick Jun 23, 2018

Choose a reason for hiding this comment

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

This is familiar syntax that always works. Shouldn't have to explain function components on the install page.

(Most components are going to have state anyways - else why would you be adding React to a static page?)

render() {
return (
<button className="btn">{this.props.label}</button>
);
}
}
```

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.
```js
// Render in several places

The smallest React example looks like this:
ReactDOM.render(
<Button label="Sign Out" />,
document.querySelector('.sign-out')
);

```js
import React from 'react';
import ReactDOM from 'react-dom';
ReactDOM.render(
<Button label="Sign In" />,
document.querySelector('.sign-in')
);

ReactDOM.render(
<h1>Hello, world!</h1>,
document.getElementById('root')
<Button label="Edit" />,
document.querySelector('.edit')
);
```

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](https://babeljs.io) is a tool that converts [JSX](/docs/introducing-jsx.html) 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`](https://yarnpkg.com) or [`npm`](https://npmjs.com)_

### A Complete Example
```shell
npm init # if you don't already have a package.json
npm install --global babel-cli
npm install babel-preset-react-app
```

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).
_Example: compile files in `src` folder to `build`_

### Development and Production Versions
```shell
NODE_ENV=development
babel --presets=react-app src -d build
```

By default, React includes many helpful warnings. These warnings are very useful in development.
### 4. Add components to page

**However, they make the development version of React larger and slower so you should use the production version when you deploy the app.**
```html
<script src="build/button.js"></script>
```

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:
### 5. Production

* [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)
You probably already have a minification step for your JavaScript - don't forget to minify your component files too!
Copy link
Contributor

Choose a reason for hiding this comment

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

don't need this, if you are using the prod version of react ( I think)

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The component scripts won't minify themselves 😄
The production CDN links are minified copies of React & ReactDOM though


### Using a CDN
_Change React scripts to production mode_

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.
```
https://unpkg.com/react@16/umd/react.<strong>production.min.js</strong>
https://unpkg.com/react-dom@16/umd/react-dom.<strong>production.min.js</strong>
```