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.
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.
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/[email protected]/dist/react.js"></script>
<!-- The ReactDOM Library -->
<script src="https://npmcdn.com/[email protected]/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 reactAnd it's just as easy with npm:
npm i --save reactThe 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.
The process to build react.js is built entirely on top of node.js, using many libraries you may already be familiar with.
- You have
nodeinstalled at v4.0.0+ andnpmat v2.0.0+. - You have
gccinstalled or are comfortable installing a compiler if needed. Some of ournpmdependencies may require a compilation step. On OS X, the Xcode Command Line Tools will cover this. On Ubuntu,apt-get install build-essentialwill install the required packages. Similar commands should work on other Linux distros. Windows will require some additional steps, see thenode-gypinstallation instructions for details. - You are familiar with
npmand know whether or not you need to usesudowhen installing packages globally. - You are familiar with
git.
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 buildAt this point, you should now have a build/ directory populated with everything you need to use React. The examples should all work.
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 cleanTo 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.
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.
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.
See the Troubleshooting Guide