-
Notifications
You must be signed in to change notification settings - Fork 7.7k
Rewrite Installation and related docs #996
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
Changes from 25 commits
4ae0060
ea62599
5d77355
3a577e0
6b6e530
90de469
6f84692
6a65d90
74edd25
91a53ec
1156655
2adaa07
fd0d7d0
ad138c7
fd22d5b
5bf8c5d
1ae845f
8267c92
785cbb7
106a702
ec791eb
4721723
4ff7899
4c3ec48
e62dc43
7ece794
5f1d5ed
713d10a
7d9b48f
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,179 @@ | ||
--- | ||
id: add-react-to-a-website | ||
title: Add React to a Website | ||
permalink: docs/add-react-to-a-website.html | ||
redirect_from: "docs/add-react-to-an-existing-app.html" | ||
prev: getting-started.html | ||
next: create-a-new-react-app.html | ||
--- | ||
|
||
Use as little or as much React as you need. | ||
|
||
React is designed for gradual adoption, and **you can use as little or as much React as you need**. Perhaps you only want to add some "sprinkles of interactivity" to an existing page. React components are a great way to do that. | ||
|
||
The majority of websites aren't, and don't need to be, single-page apps. With **a few lines of code and no build tooling**, try React in a small part of your website. You can then either gradually expand its presence, or keep it contained to a few dynamic widgets. | ||
|
||
- [Add React in One Minute](#add-react-in-one-minute) | ||
- [Optional: Try React with JSX](#optional-try-react-with-jsx) | ||
|
||
## Add React in One Minute | ||
|
||
In this section, we will show how to add a React component to an existing HTML page. You can follow along with your own website, or create an empty HTML file to practice. | ||
|
||
There will be no complicated tools or install requirements -- **to complete this section, you only need an internet connection, and a minute of your time.** | ||
|
||
Optional: [Download the full example (2KB zipped)](https://gist.github.com/gaearon/6668a1f6986742109c00a581ce704605/archive/110ba374459fbf15109acbc957c16432e6601eef.zip) | ||
|
||
### Step 1: Add a DOM Container to the HTML | ||
|
||
First, open the HTML page you want to edit. Add an empty `<div>` tag to mark the spot where you want to display something with React. For example: | ||
|
||
```html{3} | ||
<!-- ... existing HTML ... --> | ||
|
||
<div class="like_button_container"></div> | ||
|
||
<!-- ... existing HTML ... --> | ||
``` | ||
|
||
We gave this `<div>` a unique `class` HTML attribute. This will allow us to find it from the JavaScript code later and display a React component inside of it. | ||
|
||
>Tip | ||
> | ||
>You can place a "container" `<div>` like this **anywhere** inside the `<body>` tag. You may have as many independent DOM containers on one page as you need. They are usually empty -- React will replace any existing content inside DOM containers. | ||
|
||
### Step 2: Add the Script Tags | ||
|
||
Next, add three `<script>` tags to the HTML page right before the closing `</body>` tag: | ||
|
||
```html{5,6,9} | ||
<!-- ... other HTML ... --> | ||
|
||
<!-- Load React. --> | ||
<!-- Note: when deploying, replace "development.js" with "production.min.js". --> | ||
<script src="https://unpkg.com/react@16/umd/react.development.js" crossorigin></script> | ||
<script src="https://unpkg.com/react-dom@16/umd/react-dom.development.js" crossorigin></script> | ||
|
||
<!-- Load our React component. --> | ||
<script src="like_button.js"></script> | ||
|
||
</body> | ||
``` | ||
|
||
The first two tags load React. The third one will load your component code. | ||
|
||
### Step 3: Create a React Component | ||
|
||
Create a file called `like_button.js` next to your HTML page. | ||
|
||
Open this [this starter code](https://cdn.rawgit.com/gaearon/0b180827c190fe4fd98b4c7f570ea4a8/raw/b9157ce933c79a4559d2aa9ff3372668cce48de7/LikeButton.js) and paste it into the file you created. | ||
|
||
>Tip | ||
> | ||
>This code defines a React component called `LikeButton`. Don't worry if you don't understand it yet -- we'll cover the building blocks of React later in our [main concepts guide](/docs/hello-world.html) and a [hands-on tutorial](/tutorial/tutorial.html). For now, let's just get it showing on the screen! | ||
|
||
After the starter code, add two lines to the bottom of `like_button.js`: | ||
|
||
```js{3,4} | ||
// ... the starter code you pasted ... | ||
|
||
const domContainer = document.querySelector('.like_button_container'); | ||
ReactDOM.render(e(LikeButton), domContainer); | ||
``` | ||
|
||
These two lines of code find the `<div>` we added to our HTML in the first step, and then display our "Like" button React component inside of it. | ||
|
||
### That's It! | ||
|
||
There is no step four. **You have just added the first React component to your website.** | ||
|
||
Check out the next sections for more tips on integrating React. | ||
|
||
**[View the full example source code](https://gist.github.com/gaearon/6668a1f6986742109c00a581ce704605)** | ||
|
||
**[Download the full example (2KB zipped)](https://gist.github.com/gaearon/6668a1f6986742109c00a581ce704605/archive/110ba374459fbf15109acbc957c16432e6601eef.zip)** | ||
|
||
### Tip: Reuse a Component | ||
|
||
Commonly, you might want to display React components in multiple places on the HTML page. Here is an example that displays the "Like" button three times and passes some data to it: | ||
|
||
[View the full example source code](https://gist.github.com/gaearon/faa67b76a6c47adbab04f739cba7ceda) | ||
|
||
[Download the full example (2KB zipped)](https://gist.github.com/gaearon/faa67b76a6c47adbab04f739cba7ceda/archive/9d0dd0ee941fea05fd1357502e5aa348abb84c12.zip) | ||
|
||
>Note | ||
> | ||
>This strategy is mostly useful while React-powered parts of the page are isolated from each other. Inside React code, it's easier to use [component composition](/docs/components-and-props.html#composing-components) instead. | ||
|
||
### Tip: Minify JavaScript for Production | ||
|
||
Before deploying your website to production, be mindful that unminifed JavaScript can significantly slow down the page for your users. | ||
|
||
If you already minify the application scripts, all you need to do is to ensure that the deployed HTML loads the versions of React ending in `production.min.js`: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. maybe ", your site will be production-ready if you ensure…" |
||
|
||
```js | ||
<script src="https://unpkg.com/react@16/umd/react.production.min.js" crossorigin></script> | ||
<script src="https://unpkg.com/react-dom@16/umd/react-dom.production.min.js" crossorigin></script> | ||
``` | ||
|
||
If you don't have a minification step for your scripts, [here's one way to set it up](https://gist.github.com/gaearon/42a2ffa41b8319948f9be4076286e1f3). | ||
|
||
## Optional: Try React with JSX | ||
|
||
In the examples above, we only relied on features that are natively supported by the browsers. This is why we used a JavaScript function call to tell React what to display: | ||
|
||
```js | ||
const e = React.createElement; | ||
|
||
// Display a "Like" button | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. can we say
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. niiice |
||
return e( | ||
'button', | ||
{ onClick: () => this.setState({ liked: true }) }, | ||
'Like' | ||
); | ||
``` | ||
|
||
However, React also offers an option to use [JSX](/docs/introducing-jsx.html) instead: | ||
|
||
```js | ||
// Display a "Like" button | ||
return ( | ||
<button onClick={() => this.setState({ liked: true })}> | ||
Like | ||
</button> | ||
); | ||
``` | ||
|
||
These two code snippets are equivalent. While **JSX is [completely optional](/docs/react-without-jsx.html)**, many people find it helpful for writing UI code -- both with React and with other libraries. | ||
|
||
You can play with JSX using [this online converter](http://babeljs.io/repl#?babili=false&browsers=&build=&builtIns=false&spec=false&loose=false&code_lz=Q&debug=false&forceAllTransforms=false&shippedProposals=false&circleciRepo=&evaluate=false&fileSize=false&sourceType=module&lineWrap=true&presets=es2015%2Creact%2Cstage-2%2Cstage-3&prettier=true&targets=Node-6.12&version=6.26.0&envVersion=). | ||
|
||
### Add JSX to a Project | ||
|
||
If you want to add JSX to your project, follow these three steps: | ||
|
||
1. [Install Node.js](https://nodejs.org/) | ||
2. **Don't miss this step:** Run `npm init -y` in your project folder | ||
3. Run `npm install babel-cli@6 babel-preset-react-app@3` | ||
|
||
You can now use JSX! | ||
|
||
### Compile JSX with One Command | ||
|
||
Create create a folder called `src` and run this terminal command: | ||
|
||
``` | ||
npx babel --watch src --out-dir . --presets react-app/prod | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. why There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Because then we don't have to mention that they need to update path in HTML and in Uglify command they learned in previous section. I figured people who would feel it's weird are the ones who'd guess to change the output directory, and the rest would break their setups. |
||
``` | ||
|
||
>Note | ||
> | ||
>`npx` is not a typo -- it's a [package runner tool that comes with npm 5.2+](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b). | ||
> | ||
>If you see an error message saying "You have mistakingly installed the `babel` package", you might have missed [the previous step](#add-jsx-to-a-project). Perform it in the same folder, and then try again. | ||
|
||
This command starts an automated watcher for JSX. For example, if you create `src/like_button.js` with this [JSX starter code](https://cdn.rawgit.com/gaearon/c8e112dc74ac44aac4f673f2c39d19d1/raw/6132aa19e73ec872dd0fb927667e0d74dea93697/like_button.js), Babel will create a compiled `like_button.js` with the plain JavaScript code suitable for the browser. When you edit the JSX file, the transform will re-run automatically. | ||
|
||
As a bonus, this will also let you use modern JavaScript syntax features like classes without worrying about breaking older browsers. The tool we just used is called Babel, and you can learn more about it from [its documentation](http://babeljs.io/docs/en/babel-cli/). | ||
|
||
If you notice that you're getting comfortable with build tools and want them to do more for you, [the next section](/docs/create-a-new-react-app.html) describes some of the most popular and approachable toolchains. If not -- those script tags will do just fine! |
This file was deleted.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
kinda weird IMO to use a class name then only support one at this step
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I didn't want to explain that we use an ID, and then in another example we use a class. But I now realized I already collapsed by other example from a section to a downloadable snippet. So I guess I can make this an ID.