A declarative, efficient, and flexible JavaScript library for building user interfaces.
JavaScript C++ TypeScript CoffeeScript Python C
Latest commit 517a0dc Aug 27, 2016 @christophehurpeau christophehurpeau committed with Aweary doc: `npm ls react` is a better advice (#7513)
Refs Must Have Owner Warning
`npm ls react` is a better advice than `npm ls | grep react`
Permalink
Failed to load latest commit information.
.github Add basic issue and PR templates (#6597) May 11, 2016
docs doc: `npm ls react` is a better advice (#7513) Aug 27, 2016
eslint-rules Year-agnostic copyright message, like React Native uses, to prevent t… Dec 29, 2015
examples Build React DOM Fiber package (#7173) Aug 11, 2016
flow Require the isomorphic React instead of internals from renderers (#7473) Aug 12, 2016
grunt Use aliasify everywhere instead of browserify-global-shim (#7476) Aug 12, 2016
gulp/tasks ReactTestRenderer package (#7362) Jul 29, 2016
mocks Year-agnostic copyright message, like React Native uses, to prevent t… Dec 29, 2015
packages Upgrade to fbjs v0.8.4 (#7532) Aug 19, 2016
scripts Mock ReactDOM for Fiber Tests (#7206) Aug 11, 2016
src Type ReactDebugTool (#7576) Aug 26, 2016
starter Fix file reference typo in starter Nov 30, 2015
.babelrc Add babel-plugin-transform-class-properties (#7322) Jul 21, 2016
.editorconfig Add insert_final_newline to editorconfig Sep 3, 2015
.eslintignore Add (failing) React ART tests May 24, 2016
.eslintrc.js Fix function declaration in if statement (#6963) Jun 4, 2016
.flowconfig Update flow to 0.31 (#7557) Aug 25, 2016
.gitattributes .gitattributes to ensure LF line endings when we should Jan 18, 2014
.gitignore update zh-docs (v0.14.3+) Dec 24, 2015
.mailmap Update authors for v15 Apr 4, 2016
.travis.yml Switch Travis CI to Trusty Beta (#7309) Jul 20, 2016
AUTHORS Update authors for v15 Apr 4, 2016
CHANGELOG.md Update changelog for 15.3.1 Aug 19, 2016
CONTRIBUTING.md Add link to video chat with @spicyj (#7252) Jul 12, 2016
Gruntfile.js Build React DOM Fiber package (#7173) Aug 11, 2016
LICENSE Year-agnostic copyright message, like React Native uses, to prevent t… Dec 29, 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 10, 2015
README.md Fix minor typo in README.md (#7540) Aug 22, 2016
gulpfile.js Use aliasify everywhere instead of browserify-global-shim (#7476) Aug 12, 2016
package.json Update flow to 0.31 (#7557) Aug 25, 2016

README.md

React Build Status Coverage Status npm version PRs Welcome

React is a JavaScript library for building user interfaces.

  • Declarative: React makes it painless to create interactive UIs. Design simple views for each state in your application, and React will efficiently update and render just the right components when your data changes. Declarative views make your code more predictable, simpler to understand, and easier to debug.
  • Component-Based: Build encapsulated components that manage their own state, then compose them to make complex UIs. Since component logic is written in JavaScript instead of templates, you can easily pass rich data through your app and keep state out of the DOM.
  • Learn Once, Write Anywhere: We don't make assumptions about the rest of your technology stack, so you can develop new features in React without rewriting existing code. React can also render on the server using Node and power mobile apps using React Native.

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>;
  }
});

ReactDOM.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 a CDN. We're using npmcdn below but React is also available on cdnjs and jsdelivr:

<!-- The core React library -->
<script src="https://npmcdn.com/react@15.3.1/dist/react.js"></script>
<!-- The ReactDOM Library -->
<script src="https://npmcdn.com/react-dom@15.3.1/dist/react-dom.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

And it's just as easy with npm:

npm i --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 v4.0.0+ and npm at v2.0.0+.
  • You have gcc installed or are comfortable installing a compiler if needed. Some of our npm dependencies may require a compilation step. On OS X, the Xcode Command Line Tools will cover this. On Ubuntu, apt-get install build-essential will install the required packages. Similar commands should work on other Linux distros. Windows will require some additional steps, see the node-gyp installation instructions for details.
  • 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
# Lint the code with ESLint
grunt lint
# Wipe out build directory
grunt clean

Good First Bug

To help you get your feet wet and get you familiar with our contribution process, we have a list of good first bugs that contain bugs which are fairly easy to fix. This is a great place to get started.

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.

Troubleshooting

See the Troubleshooting Guide