A framework for building native apps with React. http://facebook.github.io/react-native/
Go to file
Eric Rozell 9775308458 Enable platforms to configure CLI commands
Summary:
This change adds hooks via the `package.json` for a platform plugin to specify hooks for generating platform configurations. This change also adds hooks to allow platform plugins to participate in `link` and `unlink` commands. The goal is to move platform-specific code for platform plugins into their own repositories / node_modules.

<!--
Thank you for sending the PR! We appreciate you spending the time to work on these changes.

Help us understand your motivation by explaining why you decided to make this change.

You can learn more about contributing to React Native here: http://facebook.github.io/react-native/docs/contributing.html

Happy contributing!

-->

We need to be able to configure the CLI commands for plugin platforms (e.g., react-native-windows) in their own repositories.

(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work. Bonus points for screenshots and videos!)

- All jest tests, including new tests, pass.
- `link` and `unlink` commands are successful on iOS and Android.

(If this PR adds or changes functionality, please take some time to update the docs at https://github.com/facebook/react-native-website, and link to your PR here.)

https://github.com/Microsoft/react-native-windows/pull/1601

<!--
Help reviewers and the release process by writing your own release notes

**INTERNAL and MINOR tagged notes will not be included in the next version's final release notes.**

  CATEGORY
[----------]        TYPE
[ CLI      ]   [-------------]      LOCATION
[ DOCS     ]   [ BREAKING    ]   [-------------]
[ GENERAL  ]   [ BUGFIX      ]   [-{Component}-]
[ INTERNAL ]   [ ENHANCEMENT ]   [ {File}      ]
[ IOS      ]   [ FEATURE     ]   [ {Directory} ]   |-----------|
[ ANDROID  ]   [ MINOR       ]   [ {Framework} ] - | {Message} |
[----------]   [-------------]   [-------------]   |-----------|

[CATEGORY] [TYPE] [LOCATION] - MESSAGE

 EXAMPLES:

 [IOS] [BREAKING] [FlatList] - Change a thing that breaks other things
 [ANDROID] [BUGFIX] [TextInput] - Did a thing to TextInput
 [CLI] [FEATURE] [local-cli/info/info.js] - CLI easier to do things with
 [DOCS] [BUGFIX] [GettingStarted.md] - Accidentally a thing/word
 [GENERAL] [ENHANCEMENT] [Yoga] - Added new yoga thing/position
 [INTERNAL] [FEATURE] [./scripts] - Added thing to script that nobody will see
-->

[CLI][FEATURE][local-cli/core/index.js] - Allow platform plugins to contribute to the RNConfig.
[CLI][FEATURE][local-cli/link/link.js] - Allow platform plugins to participate in the `link` command.
[CLI][FEATURE][local-cli/link/unlink.js] - Allow platform plugins to participate in the `unlink` command.
Closes https://github.com/facebook/react-native/pull/17745

Differential Revision: D6883558

Pulled By: hramos

fbshipit-source-id: ea32fe21cedd4cc02c5c0d48229f2cdb2ac8142b
2018-02-14 15:46:38 +01:00
.circleci Downgrade Buck hoping to get build fixed 2018-01-10 15:25:11 +01:00
.github Update CODEOWNERS 2017-12-22 15:46:54 -08:00
ContainerShip Fixing eslint-comments warnings 2018-01-08 17:04:29 -08:00
IntegrationTests add CoreEventTypes with LayoutEvent 2017-12-13 12:02:32 -08:00
Libraries [0.53.0] Bump version numbers 2018-02-05 15:07:44 +01:00
RNTester Adding support to float values for Android snapToInterval 2018-01-09 12:32:53 -08:00
React [0.53.0] Bump version numbers 2018-02-05 15:07:44 +01:00
ReactAndroid [0.53.0] Bump version numbers 2018-02-05 15:07:44 +01:00
ReactCommon Revert "Replace native cxx_library with fb-specific macros." 2018-01-10 15:02:37 +01:00
babel-preset react-native: move out the hardcoded import() transform 2017-11-01 05:34:40 -07:00
blog Update HTTP -> HTTPS in links in the docs 2017-12-24 16:14:22 -08:00
bots Update HTTP -> HTTPS in links in the docs 2017-12-24 16:14:22 -08:00
danger Update to Danger 2.0 2017-12-22 10:13:18 -08:00
flow Switch `declare function exports` to `declare module.exports` 2017-12-18 17:25:08 -08:00
flow-github Fix failure due to missing Metro flow types 2017-12-14 15:19:08 -08:00
gradle/wrapper Android - Update Gradle to 2.2.3 2017-01-31 13:13:32 -08:00
jest Fix Jest mocks for Dimensions module 2017-12-03 16:48:17 -08:00
keystores Apply auto-formatter for BUCK files in fbandroid. 2017-02-27 14:04:56 -08:00
lib Revert D5409825: [RN] Convert easy files to Prettier 2017-07-12 19:23:58 -07:00
local-cli Enable platforms to configure CLI commands 2018-02-14 15:46:38 +01:00
react-native-cli Revert D5409825: [RN] Convert easy files to Prettier 2017-07-12 19:23:58 -07:00
react-native-git-upgrade Fix documentation links 2018-01-09 15:46:47 -08:00
scripts Update terminal title to 'Metro Bundler' 2018-01-07 22:22:45 -08:00
third-party-podspecs Use boost-for-react-native CocoaPod 2018-01-31 07:01:50 -08:00
.buckconfig update gitignore & fix links 2017-05-22 13:03:50 -07:00
.buckjavaargs
.editorconfig
.eslintignore Split out docs to their own repo 2017-12-05 13:02:54 -08:00
.eslintrc Enable eslint-plugin-eslint-comments in RN 2018-01-08 17:04:29 -08:00
.flowconfig @allow-large-files [Flow] Upgrade xplat/js to flow v0.63 2018-01-08 12:49:53 -08:00
.gitattributes
.gitignore Adds Danger support 2017-07-18 11:16:46 -07:00
.npmignore Update .npmignore to include generated bundle file 2017-02-03 11:43:31 -08:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2017-10-26 16:47:27 -07:00
CONTRIBUTING.md Update HTTP -> HTTPS in links in the docs 2017-12-24 16:14:22 -08:00
DockerTests.md Docker Testing Environment for Android & JS 2017-02-24 10:59:53 -08:00
Jenkinsfile Container Testing Updates 2017-04-12 16:31:35 -07:00
LICENSE
LICENSE-docs
PATENTS
README.md Update HTTP -> HTTPS in links in the docs 2017-12-24 16:14:22 -08:00
React.podspec Update React.podspec for RCTText 2018-02-05 21:14:14 -08:00
Releases.md Update Releases.md 2017-07-17 14:22:43 -07:00
breaking-changes.md DOCS ONLY: Update breaking changes location in breaking-changes.md: move to Wiki 2017-02-03 06:28:37 -08:00
build.gradle
cli.js Revert D5409825: [RN] Convert easy files to Prettier 2017-07-12 19:23:58 -07:00
gradlew
gradlew.bat
jest-preset.json mock mp4 files 2017-10-20 13:05:26 -07:00
package.json [0.53.0] Bump version numbers 2018-02-05 15:07:44 +01:00
react.gradle Improve support for unbundle feature 2017-10-13 17:28:28 -07:00
rn-cli.config.js Make the runBeforeMainModule config param to RN repo and make it absolute 2017-09-26 13:06:14 -07:00
rn-get-polyfills.js Move Array<string> to $ReadOnlyArray<string>. Separate polyfill list into a file. 2017-07-13 03:38:23 -07:00
runXcodeTests.sh Re-license and rename UIExplorer integration test app as RNTester 2017-05-08 11:31:19 -07:00
settings.gradle Cleanup settings.gradle 2017-07-28 07:51:09 -07:00
setupBabel.js Rename metro-bundler to metro 2017-11-29 03:35:29 -08:00

README.md

React Native · Circle CI Status npm version PRs Welcome

Learn once, write anywhere: Build mobile apps with React.

  • Build native mobile apps using JavaScript and React: React Native lets you build mobile apps using only JavaScript. It uses the same design as React, letting you compose a rich mobile UI from declarative components.
  • A React Native app is a real mobile app: With React Native, you don't build a "mobile web app", an "HTML5 app", or a "hybrid app". You build a real mobile app that's indistinguishable from an app built using Objective-C, Java, or Swift. React Native uses the same fundamental UI building blocks as regular iOS and Android apps. You just put those building blocks together using JavaScript and React.
  • Don't waste time recompiling: React Native lets you build your app faster. Instead of recompiling, you can reload your app instantly. With hot reloading, you can even run new code while retaining your application state. Give it a try - it's a magical experience.
  • Use native code when you need to: React Native combines smoothly with components written in Objective-C, Java, or Swift. It's simple to drop down to native code if you need to optimize a few aspects of your application. It's also easy to build part of your app in React Native, and part of your app using native code directly - that's how the Facebook app works.

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.

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

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


Getting Started

Follow the Getting Started guide. The recommended way to install React Native depends on your project. Here you can find short guides for the most common scenarios:


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/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 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.


Upgrading

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


Contributing

Read below to learn how you can take part in improving React Native.

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 bug fixes and improvements, and how to build and test your changes to React Native.

Beginner Friendly Bugs

We have a list of beginner friendly issues to help you get your feet wet in the React Native codebase and familiar with our contribution process. This is a great place to get started.


License

React Native is BSD licensed. We also provide an additional patent grant.

React Native documentation is Creative Commons licensed.