React is a JavaScript library for building user interfaces.
JavaScript CSS Other
Switch branches/tags
Nothing to show
Clone or download
Pull request Compare This branch is 7059 commits behind facebook:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin Add support for a --strip-types flag to bin/jsx Sep 5, 2014
docs [docs] Use subitem in new nav generation Sep 29, 2014
examples Update Bootstrap example to 3.2.0 Sep 8, 2014
gem-react-source Move react-source gem out of project root Jul 22, 2014
grunt Upgrade Commoner Aug 18, 2014
jest Include Object.assign polyfill Jul 21, 2014
npm-react-tools Add stripTypes option to npm docs Sep 21, 2014
npm-react Bump version for 0.12.0-alpha Jul 17, 2014
perf Fix perf suite broken by descriptor change Apr 25, 2014
scripts AUTHORS Sep 10, 2013
src Merge pull request #2219 from pablolmiranda/master Sep 27, 2014
starter Add space after ellipses Sep 24, 2014
test benchmark runner Jan 6, 2014
vendor Merge pull request #2149 from imcotton/jsx-reduce-warning Sep 23, 2014
.editorconfig Don't forcibly wrap lines in git commit messages Apr 7, 2014
.gitattributes .gitattributes to ensure LF line endings when we should Jan 18, 2014
.gitignore Minimal updates for Jekyll 2.0 Aug 13, 2014
.jshintrc Cleanup lint warnings from recent testing changes Nov 14, 2013
.mailmap Update AUTHORS for 0.11 [ci skip] Jul 10, 2014
.travis.yml Fix check for commit ranges in racing PRs. Sep 5, 2014
AUTHORS Update authors/acknowledgements [skip ci] Jul 16, 2014
CHANGELOG.md v0.11.1 release materials, update to 0.11.0 release materials Jul 25, 2014
CONTRIBUTING.md Update CONTRIBUTING.md Jul 30, 2014
Gruntfile.js Move react-source gem out of project root Jul 22, 2014
LICENSE Revert "Update LICENSE" Jul 15, 2013
README.md v0.11.1 release materials, update to 0.11.0 release materials Jul 25, 2014
main.js Add support for a --strip-types flag to bin/jsx Sep 5, 2014
package.json Ignore .module-cache from jest [skip ci] Sep 11, 2014

README.md

React Build Status

React is a JavaScript library for building user interfaces.

  • Just the UI: Lots of people use React as the V in MVC. Since React makes no assumptions about the rest of your technology stack, it's easy to try it out on a small feature in an existing project.
  • Virtual DOM: React uses a virtual DOM diff implementation for ultra-high performance. It can also render on the server using Node.js — no heavy browser DOM required.
  • Data flow: React implements one-way reactive data flow which reduces boilerplate and is easier to reason about than traditional data binding.

Learn how to use React in your own project.

Examples

We have several examples on the website. Here is the first one to get you started:

/** @jsx React.DOM */
var HelloMessage = React.createClass({
  render: function() {
    return <div>Hello {this.props.name}</div>;
  }
});

React.renderComponent(
  <HelloMessage name="John" />,
  document.getElementById('container')
);

This example will render "Hello John" into a container on the page.

You'll notice that we used an HTML-like syntax; we call it JSX. JSX is not required to use React, but it makes code more readable, and writing it feels like writing HTML. A simple transform is included with React that allows converting JSX into native JavaScript for browsers to digest.

Installation

The fastest way to get started is to serve JavaScript from the CDN (also available on CDNJS):

<!-- The core React library -->
<script src="http://fb.me/react-0.11.1.js"></script>
<!-- In-browser JSX transformer, remove when pre-compiling JSX. -->
<script src="http://fb.me/JSXTransformer-0.11.1.js"></script>

We've also built a starter kit which might be useful if this is your first time using React. It includes a webpage with an example of using React with live code.

If you'd like to use bower, it's as easy as:

bower install --save react

Contribute

The main purpose of this repository is to continue to evolve React core, making it faster and easier to use. If you're interested in helping with that, then keep reading. If you're not interested in helping right now that's ok too. :) Any feedback you have about using React would be greatly appreciated.

Building Your Copy of React

The process to build react.js is built entirely on top of node.js, using many libraries you may already be familiar with.

Prerequisites

  • You have node installed at v0.10.0+ (it might work at lower versions, we just haven't tested).
  • You are familiar with npm and know whether or not you need to use sudo when installing packages globally.
  • You are familiar with git.

Build

Once you have the repository cloned, building a copy of react.js is really easy.

# grunt-cli is needed by grunt; you might have this installed already
npm install -g grunt-cli
npm install
grunt build

At this point, you should now have a build/ directory populated with everything you need to use React. The examples should all work.

Grunt

We use grunt to automate many tasks. Run grunt -h to see a mostly complete listing. The important ones to know:

# Build and run tests with PhantomJS
grunt test
# Build and run tests in your browser
grunt test --debug
# For speed, you can use fasttest and add --filter to only run one test
grunt fasttest --filter=ReactIdentity
# Lint the code with JSHint
grunt lint
# Wipe out build directory
grunt clean

More…

There's only so much we can cram in here. To read more about the community and guidelines for submitting pull requests, please read the Contributing document.