A declarative, efficient, and flexible JavaScript library for building user interfaces.
JavaScript C++ TypeScript CoffeeScript Python HTML Other
Latest commit 668d6a3 May 8, 2015 @zpao zpao v0.13.3
Permalink
Failed to load latest commit information.
bin Merge pull request #3381 from zpao/jsx-nonstrictmodule Mar 16, 2015
docs Added support for SVG clipPath element and clip-path attribute May 8, 2015
examples Merge pull request #3693 from reedloden/swap-http-to-https Apr 20, 2015
gem-react-source BSD + PATENTS Oct 10, 2014
grunt Keep docs/js/{react,JSXTransformer}.js in repo Mar 30, 2015
jest lint from root Feb 20, 2015
npm-jsx_orphaned_brackets_transformer lint from root Feb 20, 2015
npm-react-tools Merge pull request #3693 from reedloden/swap-http-to-https Apr 20, 2015
npm-react v0.13.3 May 8, 2015
perf lint: remove spaces from object braces Feb 19, 2015
scripts AUTHORS Sep 10, 2013
src v0.13.3 May 8, 2015
starter Merge pull request #3693 from reedloden/swap-http-to-https Apr 20, 2015
test eslint Feb 12, 2015
vendor [lint] fix errors from new test Mar 3, 2015
.editorconfig Don't forcibly wrap lines in git commit messages Apr 7, 2014
.eslintignore Autobuild website on Travis from stable branch Mar 30, 2015
.eslintrc update eslint rules Feb 12, 2015
.gitattributes .gitattributes to ensure LF line endings when we should Jan 18, 2014
.gitignore Autobuild website on Travis from stable branch Mar 30, 2015
.mailmap Update AUTHORS for 0.13 Mar 10, 2015
.travis.yml Fix inverted feature test in .travis.yml Apr 1, 2015
AUTHORS Update AUTHORS for 0.13 Mar 10, 2015
CHANGELOG.md Changelog for 0.13.3 May 8, 2015
CONTRIBUTING.md Merge pull request #3693 from reedloden/swap-http-to-https Apr 20, 2015
Gruntfile.js Keep docs/js/{react,JSXTransformer}.js in repo Mar 30, 2015
LICENSE Fix Outdated Copyright Year Jan 5, 2015
LICENSE-docs Update licenses for docs and examples Oct 22, 2014
LICENSE-examples Update licenses for docs and examples Oct 22, 2014
PATENTS Update Patent Grant Apr 18, 2015
README.md Readme for 0.13.3 May 8, 2015
main.js Merge pull request #3381 from zpao/jsx-nonstrictmodule Mar 16, 2015
npm-shrinkwrap.json re-shrinkwrap Apr 18, 2015
package.json v0.13.3 May 8, 2015

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 abstracts away the DOM from you, giving a simpler programming model and better performance. React can also render on the server using Node, and it can power native apps using React Native.
  • Data flow: React implements one-way reactive data flow which reduces boilerplate and is easier to reason about than traditional data binding.

NEW! Check out our newest project React Native, which uses React and JavaScript to create native mobile apps.

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:

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

React.render(
  <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 and jsdelivr):

<!-- The core React library -->
<script src="https://fb.me/react-0.13.3.js"></script>
<!-- In-browser JSX transformer, remove when pre-compiling JSX. -->
<script src="https://fb.me/JSXTransformer-0.13.3.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 ESLint
grunt lint
# Wipe out build directory
grunt clean

License

React is BSD licensed. We also provide an additional patent grant.

React documentation is Creative Commons licensed.

Examples provided in this repository and in the documentation are separately licensed.

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.