A framework for building native apps with React.
JavaScript Java Objective-C C++ Objective-C++ C Other
Switch branches/tags
Latest commit 1b16b33 Jun 1, 2017 @BryanJBryce BryanJBryce committed with facebook-github-bot Deco has a new home
Summary:
Thanks for submitting a PR! Please read these instructions carefully:

- [x] Explain the **motivation** for making this change.
- [ ] Provide a **test plan** demonstrating that the code is solid.
- [ ] Match the **code formatting** of the rest of the codebase.
- [ ] Target the `master` branch, NOT a "stable" branch.

What existing problem does the pull request solve?

Wrong URL

A good test plan has the exact commands you ran and their output, provides screenshots or videos if the pull request changes UI or updates the website. See [What is a Test Plan?][1] to learn more.

If you have added code that should be tested, add tests.

Sign the [CLA][2], if you haven't already.

Small pull requests are much easier to review and more likely to get merged. Make sure the PR does only one thing, otherwise please split it.

Make sure all **tests pass** on both [Travis][3] and [Circle CI][4]. PRs that break tests are unlikely to be merged.

For more info, see the ["Pull Requests"][5] section of our "Contributing" guidelines.

[1]: https://medium.com/martinkonicek/what-is-a-test-plan-8bfc840ec171#.y9lcuqqi9
[2]: https://code.facebook.com/cla
[3]: https://travis-ci.org/facebook/react-native
[4]: http://circleci.com/gh/facebook/react-native
[5]: https://github.com/facebook/react-native/blob/master/CONTRIBUTING.md#pull-requests
Closes #14179

Differential Revision: D5159951

Pulled By: shergin

fbshipit-source-id: fd2ef3d4dbcdc4bd5dfecdf8180a9f4da4f29602
Permalink
Failed to load latest commit information.
.github MacOS -> macOS May 10, 2017
ContainerShip Container Testing Updates Apr 12, 2017
IntegrationTests Fix react-native function call arity errors May 18, 2017
JSCLegacyProfiler Add suport for JSC profiling on iOS 9 Nov 16, 2015
Libraries Using <Image> with nested content now causes warning (yellowbox) May 31, 2017
RNTester RCTTextField was spliited into two classes May 29, 2017
React Ignore "Frame load interrupted" errors in UIWebView May 31, 2017
ReactAndroid Avoid using path for normal border cases May 31, 2017
ReactCommon Make isCustomJSCWrapperSet and setCustomJSCWrapper visible when using… May 31, 2017
babel-preset Enable JSX source plugin in DEV and integrate it with React DevTools May 12, 2017
blog Rename UIExplorer in docs May 8, 2017
bots Code analysis bot does not need to comment on merge commits Apr 3, 2017
docs Deco has a new home May 31, 2017
flow Fix react-native function call arity errors May 18, 2017
gradle/wrapper Android - Update Gradle to 2.2.3 Jan 31, 2017
jest Move remaining Metro Bundler files around. May 31, 2017
keystores Apply auto-formatter for BUCK files in fbandroid. Feb 27, 2017
lib Reorganize core JS files Oct 11, 2016
local-cli Move remaining Metro Bundler files around. May 31, 2017
packager Move remaining Metro Bundler files around. May 31, 2017
react-native-cli 14081 mute yarn check error on Windows May 26, 2017
react-native-git-upgrade Fix react-native-git-upgrade cache busting Feb 19, 2017
scripts Fix some issues with the React podspec for the Cxx bridge May 30, 2017
third-party-podspecs Fix some issues with the React podspec for the Cxx bridge May 30, 2017
website Add support for syntax highlighting for languages other than JS May 30, 2017
.buckconfig update gitignore & fix links May 22, 2017
.buckjavaargs limiting BUCK's memory for CI Feb 1, 2016
.editorconfig Fix indent of .gradle files Oct 19, 2016
.eslintignore packager: fork local version of worker-farm May 3, 2017
.eslintrc XHR: support typed arrays for request payloads Jan 21, 2017
.flowconfig Flat ReactNative renderer bundle [WIP] May 26, 2017
.gitattributes Added a .gitattributes file, ensuring that Bash script source files (… Oct 14, 2015
.gitignore update gitignore & fix links May 22, 2017
.npmignore Update .npmignore to include generated bundle file Feb 3, 2017
.travis.yml Add a flag to support a simplified iOS test - just compile, don't run… Mar 16, 2017
CONTRIBUTING.md Shorten template instructions. Mar 16, 2017
DockerTests.md Docker Testing Environment for Android & JS Feb 24, 2017
Jenkinsfile Container Testing Updates Apr 12, 2017
LICENSE Update license Mar 23, 2015
LICENSE-docs More licenses Mar 25, 2015
PATENTS Update Patent Grant Apr 10, 2015
README.md Replace Navigator references to with existing components May 30, 2017
React.podspec Fix some issues with the React podspec for the Cxx bridge May 30, 2017
Releases.md Support the --remote option in bump-oss-version.js script Feb 6, 2017
Windows Fix tutorial link in README.md Jun 14, 2016
breaking-changes.md DOCS ONLY: Update breaking changes location in breaking-changes.md: m… Feb 3, 2017
build.gradle Update gradle-download-task from 2.0.0 to 3.1.2 to fix boost zip down… Dec 8, 2016
circle.yml disable Circle e2e tests Apr 21, 2017
cli.js packager: centralize babelRegisterOnly callsites Jan 6, 2017
gradlew Update gradle wrapper binary and scripts Sep 9, 2016
gradlew.bat Update gradle wrapper binary and scripts Sep 9, 2016
jest-preset.json Add missing slash. Dec 8, 2016
package.json Update inquirer package to better support interactive command line pr… May 31, 2017
react.gradle Add ability to customize CLI path Apr 10, 2017
rn-cli.config.js Add a local packager config, so that react can find react-native when… Jul 5, 2016
runXcodeTests.sh Re-license and rename UIExplorer integration test app as RNTester May 8, 2017
settings.gradle Re-license and rename UIExplorer integration test app as RNTester May 8, 2017
setupBabel.js Move remaining Metro Bundler files around. May 31, 2017

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.

  • Ask a question on StackOverflow and tag it with react-native
  • Chat with us on Reactiflux in #react-native
  • Articulate your feature request or upvote existing ones on Canny
  • Start a thread on the React Discussion Board
  • Join #reactnative on IRC: chat.freenode.net
  • If it turns out that you may have found a bug, please open an issue

Documentation

The website’s 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/Components directory for components like ScrollView and TextInput, for example. The RNTester 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 component’s 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 RNTester app on iOS

Now open RNTester/RNTester.xcodeproj and hit Run in Xcode.

Running the RNTester app on Android

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

./gradlew :RNTester:android:app:installDebug
# Start the packager in a separate shell (make sure you ran npm install):
./scripts/packager.sh

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 doesn’t already exist before opening a new issue. It’s helpful if you include the version of React Native and OS you’re 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. Canny 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.