Getting Started With React



MVC is a very popular paradigm in web development and has been around for quite some time. The React framework is an powerful part of that Model-View-Controller trinity, because it focuses purely on the View alone. React is written in JavaScript and created by the Facebook and Instagram development teams.
React is being used all over the web to create rapid web applications that are easy to maintain due to the way the React framework structures the view layer code.
What Can React Do?
- Build lightning fast, responsive isomorphic web apps, agnostic of frameworks. React makes no assumptions about the technology stack it resides in.
- Virtual DOM manipulation provides you with a simple programming model which can be rendered in the browser, on the server or the desktop with React Native.
- Data flow bindings with React are designed as a one-way reactive data flow. This reduces boilerplate requirements and is easier to work with than traditional methods.
Hello World
To get us started, here is a simple example of React taken from the official examples:
1 |
|
2 |
var HelloMessage = React.createClass({ |
3 |
render: function() { |
4 |
return Hello {this.props.name}; |
5 |
}
|
6 |
});
|
7 |
|
8 |
React.render( |
9 |
,
|
10 |
document.getElementById('container') |
11 |
);
|
This example will render ‘Hello John’ into a <div>
container. Take notice of the XML/HTML-like syntax that is used on lines 3 and 8. This is called JSX.
What’s JSX?
JSX is an XML/HTML-like syntax which is used to render HTML from within JavaScript code. React transforms JSX into native JavaScript for the browser, and with the tools provided you can convert your existing sites’ HTML code into JSX!
JSX makes for easy code-mingling as it feels just like writing native HTML but from within JavaScript. Combined with Node, this makes for a very consistent workflow.
JSX is not required to use React—you can just use plain JS—but it is a very powerful tool that makes it easy to define tree structures with and assign attributes, so I do highly recommend its usage.
To render an HTML tag in React, just use lower-case tag names with some JSX like so:
1 |
|
2 |
//className is used in JSX for class attribute
|
3 |
var fooDiv = ; |
4 |
// Render where div#example is our placeholder for insertion
|
5 |
ReactDOM.render(fooDiv, document.getElementById('example')); |
Installing React
There are several ways to use React. The officially recommended way is from the npm or Facebook CDN, but additionally you can clone from the git and build your own. Also you can use the starter kit or save time with a scaffolding generator from Yeoman. We will cover all of these methods so you have a full understanding.
Using the Facebook CDN
For the fastest way to get going, just include the React and React Dom libraries from the fb.me CDN as follows:
1 |
|
2 |
|
3 |
|
4 |
|
5 |
Installation From NPM
The React manual recommends using React with a CommonJS module system like browserify or webpack.
The React manual also recommends using the react
and react-dom
npm packages. To install these on your system, run the following at the bash terminal prompt inside your project directory, or create a new directory and cd
to it first.
1 |
|
2 |
$ npm install --save react react-dom |
3 |
$ browserify -t babelify main.js -o bundle.js |
You will now be able to see the React installation inside the node_modules
directory.
Installation From Git Source
Dependencies
You need to have Node V4.0.0+ and npm v2.0.0+. You can check your node version with node version
and npm with npm version
Updating Node via NVM
I recommend using the nvm - node version manager to update and select your node version. It’s easy to acquire nvm by simply running:
1 |
|
2 |
curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.29.0/install.sh | bash
|
This script clones the nvm repository to ~/.nvm
and adds the source line to your profile (~/.bash_profile
, ~/.zshrc
or ~/.profile
).
If you wish to manually install nvm
you can do so via git
with:
1 |
|
2 |
git clone https://github.com/creationix/nvm.git ~/.nvm && cd ~/.nvm && git checkout `git describe --abbrev=0 --tags` |
To activate nvm with this method, you need to source it from shell with:
1 |
|
2 |
. ~/.nvm/nvm.sh
|
Note: Add this line to your ~/.bashrc
, ~/.profile
, or ~/.zshrc
files respectively to have it automatically sourced upon login.
Using NVM
With nvm now installed, we can get any version of node we require, and can check the list of installed versions with node list
and the ones available with node ls-remote
. We need a version higher than 4.0.0 to work with React.
Install the newest version and set it as the default version with the following:
1 |
|
2 |
$ nvm install 4.2.1 |
3 |
$ nvm alias default 4.2.1 |
4 |
default -> 4.2.1 (-> v4.2.1) |
5 |
$ nvm use default
|
6 |
Now using node v4.2.1 (npm v2.14.7) |
Node is updated and npm is included in the deal. You’re now ready to roll with the installation.
Build React From Git Source
Clone the repository with git into a directory named react
on your system with:
1 |
|
2 |
git clone https://github.com/facebook/react.git |
Once you have the repo cloned, you can now use grunt
to build React:
1 |
|
2 |
# grunt-cli is needed by grunt; you might have this installed already but lets make sure with the following
|
3 |
$ sudo npm install -g grunt-cli |
4 |
$ npm install |
5 |
$ grunt build
|
At this point, a build/
directory has been populated with everything you need to use React. Have a look at the /examples
directory to see some basic examples working!
Using the Starter Kit
First of all download the starter kit.
Extract the zip and in the root create a helloworld.html
, adding the following:
1 |
|
2 |
|
3 |
|
4 |
|
5 |
|
6 |
Hello React! |
7 |
|
8 |
|
9 |
|
10 |
|
11 |
|
12 |
|
13 |
|
14 |
ReactDOM.render( |
15 |
<h1>Hello, world!</h1>, |
16 |
document.getElementById('example') |
17 |
); |
18 |
|
19 |
|
20 |
In this example, React uses Babel to transform the JSX into plain JavaScript via the <script type="text/babel">
.
Using a Separate JavaScript File
Create a new file at src/helloworld.js
and place the following code inside it:
1 |
|
2 |
ReactDOM.render( |
3 |
Hello, world!, |
4 |
document.getElementById('example') |
5 |
);
|
Now all you need to do is reference it in your HTML, so open up the helloworld.html
and load the script you just created using a script
tag with a text/babel
type attribute as so:
1 |
|
2 |
|
3 |
|
4 |
|
5 |
Refresh the page and you will see the `helloworld.js` being rendered by babel. |
6 |
|
7 |
Note: Some browsers (for example Chrome) will fail to load the file unless it's served via HTTP, so ensure you're using a local server. I recommend the [browsersync project](http://www.browsersync.io/). |
8 |
|
9 |
### Offline Transformation |
10 |
You can also use the command-line interface (CLI) to transform your JSX via using the babel command-line tools. This is easily acquired via the npm command: |
11 |
|
12 |
|
13 |
$ sudo npm install --global babel |
14 |
|
15 |
|
16 |
The `--global` or `-g` flag for short will install the babel package globally so that it is available everywhere. This is a very good practice with using Node for multiple projects and command-line tools. |
17 |
|
18 |
Now that babel is installed, let's do the translation of the `helloworld.js` we just created in the step before. |
19 |
At the command prompt from the root directory where you unzipped the starter kit, run: |
20 |
|
21 |
|
22 |
$ babel src --watch --out-dir build |
23 |
|
24 |
|
25 |
Now the file `build/helloworld.js` will be auto-generated whenever you make a change! If you are interested, read the [Babel CLI documentation](http://babeljs.io/docs/usage/cli/) to get a more advanced knowledge. |
26 |
|
27 |
Now that babel has generated the `build/helloworld.js`, which contains just straight-up JavaScript, update the HTML without any babel-enabled script tags. |
28 |
|
29 |
|
30 |
|
31 |
|
32 |
|
33 |
|
34 |
Hello React! |
35 |
|
36 |
|
37 |
|
38 |
|
39 |
|
40 |
|
41 |
|
42 |
|
43 |
|
44 |
|
45 |
|
46 |
So to recap, with babel we can load JSX directly inside a `script` tag via the `text/babel` type attribute. This is good for development purposes, but for going to production we can provide a generated JavaScript file which can be cached on the user's local machine. |
47 |
|
48 |
Generation of this copy is done on the command line, and as this is a repetitive task I highly recommend automating the process via using the `--watch` flag. Or you can go a step further and utilize `webpack` and `browsersync` to fully automate your development workflow. To do that in the easiest path possible, we can automate the setup of a new project with a Yeoman generator. |
49 |
|
50 |
## Installing With Yeoman Scaffolding |
51 |
Yeoman is a very useful tool for starting projects quickly and with an optimal workflow and tool configuration. The idea is to let you spend more time on development than configuration of the project's work area, and to minimize repetitive tasks (be aware of this—RSI is the number one reason coders stop coding). So as a best practice, saving time with tools and implementing D.R.Y (Don't Repeat Yourself) in your day-to-day life will boost your health and efficiency, and let you spend more time doing actual code rather than configuration. |
52 |
|
53 |
There are a lot of scaffoldings out there, coming in many flavours for different scales of project. For this first example we will be using the `react-fullstack` scaffolding from the Yeoman generators; you can see a [demo](http://demo.reactstarterkit.com/) of what the end result looks like. |
54 |
|
55 |
Note: This is a fullstack configuration, which is probably overkill for any small projects. The reason I select this scaffolding is to give you a fully set-up environment, so you can see how the starter kit fleshes out into a larger app. There's a header and footer, and you can see where a user login and register feature will go, although they are not coded yet in the example. |
56 |
|
57 |
### Usage |
58 |
To use yeoman, first install it, and if you do not have yeoman's required counterparts `gulp`, `bower` and `grunt-cli`, install them as so: |
59 |
|
60 |
|
61 |
$ sudo npm install -g yo bower grunt-cli gulp |
62 |
|
63 |
|
64 |
Now install the React scaffolding with: |
65 |
|
66 |
|
67 |
$ sudo npm install -g generator-react-fullstack |
68 |
|
69 |
|
70 |
Now create a directory for your project and `cd` to it: |
71 |
|
72 |
|
73 |
$ mkdir react-project |
74 |
$ cd react-project |
75 |
|
76 |
|
77 |
Finally use the `yo` command with the React-fullstack scaffolding generator to create your react app inside the directory: |
78 |
|
79 |
|
80 |
$ yo react-fullstack |
81 |
|
82 |
|
83 |
Yeoman will now create the directories and files required; you will be able to see updates about this in the command line. |
84 |
|
85 |
With the scaffolding now set up, let's build our project: |
86 |
|
87 |
|
88 |
$ npm start |
89 |
|
90 |
|
91 |
By default we start in *debug* mode, and to go live we just add the `-- release` flag, e.g. `npm run start -- release`. |
92 |
|
93 |
You will now see the build starting and webpack initializing. Once this is done, you will see the webpack output telling you detailed information about the build and the URLs to access from. |
94 |
|
95 |
|
96 |
Access your app via the URLs listed at the end of the output, with your browser by default at http://localhost:3000. To access the browser sync admin interface, go to http://localhost:3001. |
97 |
|
98 |
|
99 |
Note: You may need to open the port on your server for the development port. For ubuntu / debian users with `ufw`, do the following: |
100 |
|
101 |
|
102 |
$ ufw allow 3001/tcp |
103 |
$ ufw allow 3000/tcp |
104 |
|
105 |
|
106 |
## Converting Your Existing Site to JSX |
107 |
Facebook provides an [online tool](http://facebook.github.io/react/html-jsx.html) if you need to just convert a snippet of your HTML into JSX. |
108 |
|
109 |
For larger requirements there is a tool on `npm` for that named `htmltojsx`. Download it with: |
110 |
|
111 |
|
112 |
npm install htmltojsx |
113 |
|
114 |
|
115 |
Using it via the command line is as simple as: |
116 |
|
117 |
|
118 |
$ htmltojsx -c MyComponent existing_code.htm |
119 |
|
120 |
|
121 |
Because `htmltojsx` is a node module, you can also use it directly in the code, for example: |
122 |
|
123 |
|
124 |
var HTMLtoJSX = require('htmltojsx'); |
125 |
var converter = new HTMLtoJSX({ |
126 |
createClass: true, |
127 |
outputClassName: 'HelloWorld' |
128 |
}); |
129 |
var output = converter.convert('Hello world!'); |
130 |
|
131 |
|
132 |
|
133 |
## List Example |
134 |
|
135 |
Let's start working on creating a basic to-do list so you can see how React works. Before we begin, please configure your IDE. I recommend using Atom. |
136 |
|
137 |
At the bash prompt, install the linters for React via apm: |
138 |
|
139 |
|
140 |
apm install linter linter-eslint react |
141 |
Installing linter to /Users/tom/.atom/packages ✓ |
142 |
Installing linter-eslint to /Users/tom/.atom/packages ✓ |
143 |
Installing react to /Users/tom/.atom/packages ✓ |
144 |
|
145 |
|
146 |
Note: the latest version of `linter-eslint` was making my MacBook Pro very slow, so I disabled it. |
147 |
|
148 |
Once that is done, we can get going on creating a basic list within the scaffolding we made in the prior step with Yeoman, to show you a working example of the data flow. |
149 |
|
150 |
Make sure your server is started with `npm start`, and now let's start making some changes. |
151 |
|
152 |
First of all there are three jade template files provided in this scaffolding. We won't be using them for the example, so start by clearing out the `index.jade` file so it's just an empty file. Once you save the file, check your browser and terminal output. |
153 |
|
154 |
The update is displayed instantly, without any need to refresh. This is the webpack and browsersync configuration that the scaffolding has provided coming into effect. |
155 |
|
156 |
Next open the components directory and create a new directory: |
157 |
|
158 |
|
159 |
$ cd components |
160 |
$ mkdir UserList |
161 |
|
162 |
|
163 |
Now, inside the `UserList` directory, create a `package.json` file with the following: |
164 |
|
165 |
|
166 |
{ |
167 |
"name": "UserList", |
168 |
"version": "0.0.0", |
169 |
"private": true, |
170 |
"main": "./UserList.js" |
171 |
} |
172 |
|
173 |
|
174 |
Also, still inside the `UserList` directory, create the `UserList.js` file and add the following: |
175 |
|
176 |
|
177 |
//Import React |
178 |
import React, { PropTypes, Component } from 'react'; |
179 |
|
180 |
//Create the UserList component |
181 |
class UserList extends Component { |
182 |
|
183 |
//The main method render is called in all components for display |
184 |
render(){ |
185 |
|
186 |
//Uncomment below to see the object inside the console |
187 |
//console.log(this.props.data); |
188 |
|
189 |
//Iterate the data provided here |
190 |
var list = this.props.data.map(function(item) { |
191 |
return |
-
{list}
1 |
|
2 |
/*! React Starter Kit | MIT License | http://www.reactstarterkit.com/ */
|
3 |
|
4 |
import React, { PropTypes, Component } from 'react'; |
5 |
import styles from './ContentPage.css'; |
6 |
import withStyles from '../../decorators/withStyles'; |
7 |
import UserList from '../UserList'; //Here we import the UserList component we created |
8 |
|
9 |
@withStyles(styles) |
10 |
|
11 |
class ContentPage extends Component { |
12 |
|
13 |
static propTypes = { |
14 |
path: PropTypes.string.isRequired, |
15 |
content: PropTypes.string.isRequired, |
16 |
title: PropTypes.string, |
17 |
};
|
18 |
|
19 |
static contextTypes = { |
20 |
onSetTitle: PropTypes.func.isRequired, |
21 |
};
|
22 |
|
23 |
render() { |
24 |
|
25 |
//Define some data for the list
|
26 |
var listData = [ |
27 |
{first:'Peter',last:'Tosh'}, |
28 |
{first:'Robert',last:'Marley'}, |
29 |
{first:'Bunny',last:'Wailer'}, |
30 |
];
|
31 |
|
32 |
this.context.onSetTitle(this.props.title); |
33 |
|
34 |
return ( |
35 |
|
36 |
|
37 |
{
|
38 |
this.props.path === '/' ? null : {this.props.title} |
39 |
}
|
40 |
|
41 |
|
42 |
//Use the UserList component as JSX
|
43 |
|
44 |
|
45 |
|
46 |
|
47 |
);
|
48 |
}
|
49 |
|
50 |
}
|
51 |
|
52 |
export default ContentPage; |
1 |
|
2 |
var list = this.props.data.map(function(item) { |
3 |
return
|
1 |
|
2 |
var listData = [ |
3 |
{first:'Peter',last:'Tosh'}, |
4 |
{first:'Robert',last:'Marley'}, |
5 |
{first:'Bunny',last:'Wailer'}, |
6 |
];
|
1 |
|
2 |
var MyListItem = React.createClass({ |
3 |
render: function() { |
4 |
return
|
-
{this.props.results.map(function(result) {
return