A framework for building native apps with React. http://facebook.github.io/react-native/
Go to file
Bhuwan Khattar d82f2553fb Replace @provides with @providesModule
Reviewed By: davidaurelio

Differential Revision: D4494624

fbshipit-source-id: 192cc77126a99b3a3baeb806ed605c2194c4713a
2017-02-02 08:58:33 -08:00
.github Ask for solutions in new issue template. 2016-11-11 09:43:48 -08:00
Examples Replace @provides with @providesModule 2017-02-02 08:58:33 -08:00
IntegrationTests Cache policy control for image source 2017-01-17 17:13:31 -08:00
JSCLegacyProfiler Add suport for JSC profiling on iOS 9 2015-11-16 03:38:11 -08:00
Libraries BREAKING - Improve JS transform validation, add tests 2017-02-02 06:28:31 -08:00
React Replace MethodCallResult with folly::Optional 2017-02-02 05:13:33 -08:00
ReactAndroid Fix Buck files after removing RecyclerViewBackedScrollView 2017-02-02 05:28:34 -08:00
ReactCommon Replace MethodCallResult with folly::Optional 2017-02-02 05:13:33 -08:00
babel-preset Update babel-preset, filter path by identifiers. 2016-11-23 09:28:27 -08:00
blog Blog post about new versions and release cadence 2017-01-09 01:14:09 -08:00
bots Add myself to the issue task force 2017-01-23 12:13:27 -08:00
docs Add static non-image assets section 2017-01-31 13:28:32 -08:00
flow amend babel definitions to allow inline plugins without configuration 2017-01-20 10:43:29 -08:00
gradle/wrapper Android - Update Gradle to 2.2.3 2017-01-31 13:13:32 -08:00
jest Remove `react-packager` indirection. 2017-02-02 05:44:15 -08:00
keystores Added ability to run Movies app with BUCK 2016-02-25 17:15:58 -08:00
lib Reorganize core JS files 2016-10-11 10:14:28 -07:00
local-cli Remove `react-packager` indirection. 2017-02-02 05:44:15 -08:00
packager Replace @provides with @providesModule 2017-02-02 08:58:33 -08:00
react-native-cli Run application using package.json scripts 2017-01-20 06:43:41 -08:00
react-native-git-upgrade Fix react-native-git-upgrade by get package.json instead of selective field 2016-12-09 07:58:34 -08:00
scripts Add an integration test for WebSocket 2017-01-16 13:28:43 -08:00
website Replace @provides with @providesModule 2017-02-02 08:58:33 -08:00
.buckconfig Allow building UIExplorer with Buck 2016-04-12 13:05:24 -07:00
.buckjavaargs limiting BUCK's memory for CI 2016-02-01 10:49:33 -08:00
.editorconfig Fix indent of .gradle files 2016-10-19 16:58:36 -07:00
.eslintignore [ReactNative] clean lint in all of Libraries/ 2015-05-19 13:47:04 -08:00
.eslintrc XHR: support typed arrays for request payloads 2017-01-20 18:43:27 -08:00
.flowconfig Fix the suppress comment regex for react_native 2017-01-19 10:28:28 -08:00
.gitattributes Added a .gitattributes file, ensuring that Bash script source files (gradlew and 2015-10-13 23:10:39 -04:00
.gitignore Improve Android testing scripts 2016-12-13 17:13:35 -08:00
.npmignore Merge rnpm into react-native 2016-05-20 04:58:26 -07:00
.travis.yml Apple TV support 6: Add tvOS target to react-native-cli template project 2016-12-30 18:43:59 -08:00
CONTRIBUTING.md Update Edit on GitHub links to point to master 2016-08-03 17:43:49 -07:00
LICENSE Update license 2015-03-23 10:48:39 -07:00
LICENSE-CustomComponents Add CustomComponents license 2015-03-26 11:03:30 -07:00
LICENSE-docs More licenses 2015-03-24 19:59:10 -07:00
LICENSE-examples More licenses 2015-03-24 19:59:10 -07:00
PATENTS Update Patent Grant 2015-04-10 12:14:22 -07:00
README.md Match CircleCI badge 2017-01-30 19:13:36 -08:00
React.podspec Stop copying unused JS files into the Pods folder 2017-01-11 12:43:34 -08:00
Releases.md Update `releases` to refer to month instead of two weeks 2016-12-02 04:58:34 -08:00
Windows Fix tutorial link in README.md 2016-06-14 06:43:49 -07:00
breaking-changes.md Update breaking-changes.md 2016-01-16 21:56:57 +00:00
build.gradle Update gradle-download-task from 2.0.0 to 3.1.2 to fix boost zip down… 2016-12-07 16:43:28 -08:00
circle.yml Re-enable Android e2e test 2017-01-16 05:28:26 -08:00
cli.js packager: centralize babelRegisterOnly callsites 2017-01-06 06:13:54 -08:00
gradlew Update gradle wrapper binary and scripts 2016-09-09 08:13:59 -07:00
gradlew.bat Update gradle wrapper binary and scripts 2016-09-09 08:13:59 -07:00
ios-cc.sh Add scripts to fetch external third-party dependencies. 2017-02-01 14:14:32 -08:00
ios-install-third-party.sh Add scripts to fetch external third-party dependencies. 2017-02-01 14:14:32 -08:00
jest-preset.json Add missing slash. 2016-12-07 20:58:30 -08:00
package.json Add scripts to fetch external third-party dependencies. 2017-02-01 14:14:32 -08:00
react.gradle Fix missing static images when using data binding 2016-09-28 04:28:38 -07:00
rn-cli.config.js Add a local packager config, so that react can find react-native when… 2016-07-05 10:28:24 -07:00
runXcodeTests.sh Add suggested ‘view size’ powers to -[RCTShadowView setFrame:] 2016-03-01 10:14:32 -08:00
settings.gradle Android: TicTacToe Example Project 2016-08-09 07:58:30 -07:00
setupBabel.js Remove `react-packager` indirection. 2017-02-02 05:44:15 -08:00

README.md

React Native Build Status Circle CI npm version

React Native enables you to build world-class application experiences on native platforms using a consistent developer experience based on JavaScript and React. The focus of React Native is on developer efficiency across all the platforms you care about - learn once, write anywhere. Facebook uses React Native in multiple production apps and will continue investing in React Native.

Supported operating systems are >= Android 4.1 (API 16) and >= iOS 8.0.

Introduction

See the official React Native website for an introduction to React Native.

Getting Started

Getting Help

Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them.

Documentation

The websites documentation is divided into multiple sections.

Another great way to learn more about the components and APIs included with React Native is to read their source. Look under the Libraries directory for components like ScrollView and Navigator, for example. The UIExplorer example is also here to demonstrate some of the ways to use these components. From the source you can get an accurate understanding of each components behavior and API.

The React Native documentation only discusses the components, APIs and topics specific to React Native (React on iOS and Android). For further documentation on the React API that is shared between React Native and React DOM, refer to the React documentation.

Examples

  • git clone https://github.com/facebook/react-native.git
  • cd react-native && npm install

Running the examples on iOS

Now open any example (the .xcodeproj file in each of the Examples subdirectories) and hit Run in Xcode.

Running the examples on Android

Note that you'll need the Android NDK installed, see prerequisites.

./gradlew :Examples:Movies:android:app:installDebug
# Start the packager in a separate shell (make sure you ran npm install):
./packager/packager.sh
# Open the Movies app in your emulator

Extending React Native

  • Looking for a component? JS.coach
  • Fellow developers write and publish React Native modules to npm and open source them on GitHub.
  • Making modules helps grow the React Native ecosystem and community. We recommend writing modules for your use cases and sharing them on npm.
  • Read the guides on Native Modules (iOS, Android) and Native UI Components (iOS, Android) if you are interested in extending native functionality.

Upgrading

React Native is under active development. See the guide on upgrading React Native to keep your project up-to-date.

Opening Issues

If you encounter a bug with React Native we would like to hear about it. Search the existing issues and try to make sure your problem doesnt already exist before opening a new issue. Its helpful if you include the version of React Native and OS youre using. Please include a stack trace and reduced repro case when appropriate, too.

The GitHub issues are intended for bug reports and feature requests. For help and questions with using React Native please make use of the resources listed in the Getting Help section. Product Pains in particular is a good way to signal your interest in a feature or issue. There are limited resources available for handling issues and by keeping the list of open issues lean we can respond in a timely manner.

Contributing

For more information about contributing PRs and issues, see our Contribution Guidelines.

Good First Task is a great starting point for PRs.

We encourage the community to ask and answer questions on Stack Overflow with the react-native tag. It's a great way to help out and be involved!

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, as are some of the custom components.