Go to file
Ivan Zotov b3b13919c7 Improve devtools image size for the tutorial (#8114) 2016-10-27 13:54:18 +01:00
.github use npm-run-script in PULL_REQUEST_TEMPLATE (#7913) 2016-10-07 14:23:37 +01:00
docs Improve devtools image size for the tutorial (#8114) 2016-10-27 13:54:18 +01:00
eslint-rules Year-agnostic copyright message, like React Native uses, to prevent the need for yearly changes. 2015-12-29 20:20:32 +01:00
examples Add Fiber Debugger (#8033) 2016-10-25 08:36:37 +01:00
flow Require the isomorphic React instead of internals from renderers (#7473) 2016-08-11 18:56:55 -07:00
grunt Add Fiber Debugger (#8033) 2016-10-25 08:36:37 +01:00
gulp/tasks ReactTestRenderer package (#7362) 2016-07-28 21:39:05 -07:00
mocks Year-agnostic copyright message, like React Native uses, to prevent the need for yearly changes. 2015-12-29 20:20:32 +01:00
packages Add Fiber Debugger (#8033) 2016-10-25 08:36:37 +01:00
scripts Introduce facts-tracker (#7747) 2016-09-26 12:58:51 -07:00
src Fix lint errors (#8113) 2016-10-27 13:03:32 +01:00
starter Fix file reference typo in starter 2015-11-29 18:07:31 -08:00
.babelrc Add babel-plugin-transform-class-properties (#7322) 2016-07-20 17:39:10 -07:00
.editorconfig Add insert_final_newline to editorconfig 2015-09-03 13:43:42 -07:00
.eslintignore Add (failing) React ART tests 2016-05-24 16:44:33 -07:00
.eslintrc.js Fix function declaration in if statement (#6963) 2016-06-04 13:37:57 -07:00
.flowconfig Update Flow and fix issues (#8006) 2016-10-18 15:26:40 +01:00
.gitattributes .gitattributes to ensure LF line endings when we should 2014-01-17 16:25:53 -08:00
.gitignore New Documentation 2016-10-21 20:59:08 +01:00
.mailmap Update authors for v15 2016-04-04 09:46:23 -07:00
.travis.yml Update website on Travis when only new files are added (#8037) 2016-10-22 21:41:29 +01:00
AUTHORS Update authors for v15 2016-04-04 09:46:23 -07:00
CHANGELOG.md Fix: updated with new docs links (#8049) 2016-10-22 21:53:52 +01:00
CONTRIBUTING.md Move How to Contribute to documentation and update it (#7817) 2016-09-27 23:20:49 +01:00
Gruntfile.js Add Fiber Debugger (#8033) 2016-10-25 08:36:37 +01:00
LICENSE Year-agnostic copyright message, like React Native uses, to prevent the need for yearly changes. 2015-12-29 20:20:32 +01:00
LICENSE-docs Update licenses for docs and examples 2014-10-22 12:35:08 -07:00
LICENSE-examples Update licenses for docs and examples 2014-10-22 12:35:08 -07:00
PATENTS Update Patent Grant 2015-04-10 12:15:29 -07:00
README.md "take part in" is the correct saying (#8013) 2016-10-22 21:57:57 +01:00
gulpfile.js Add Fiber Debugger (#8033) 2016-10-25 08:36:37 +01:00
package.json Add npm v4.0.0 support (#8082) 2016-10-24 23:57:12 +01:00
yarn.lock Fix lint with yarn (#7997) 2016-10-20 17:49:40 -04:00

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:

class HelloMessage extends React.Component {
  render() {
    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 unpkg below but React is also available on cdnjs and jsdelivr:

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

Contributing

The main purpose of this repository is to continue to evolve React core, making it faster and easier to use. Development of React happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements. Read below to learn how you can take part in improving React.

Code of Conduct

Facebook has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

Contributing Guide

Read our contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to React.

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.

Troubleshooting

See the Troubleshooting Guide