79e498b7fb
Summary: Thanks for submitting a PR! Please read these instructions carefully: - [ ] 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? Currently, it is not possible to spawn the packager in a specific terminal on Linux and Mac OS X. For example, after applying this patch, starting the packager in a new xfce terminal on Linux can be done using: react-native run-android --terminal /usr/bin/xfce4-terminal When the command is ran a second time, and the terminal is still running, the command will not spawn a new terminal for the packager. The option 'open' is renamed to 'terminal' for consistency. Note that the option 'open' was never exposed to the CLI though. 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. See command above. 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 https://github.com/facebook/react-native/pull/13065 Differential Revision: D5700713 Pulled By: hramos fbshipit-source-id: d9729a484c0c0e8f95edabe4309ed7800c9a9c14 |
||
---|---|---|
.github | ||
ContainerShip | ||
IntegrationTests | ||
Libraries | ||
RNTester | ||
React | ||
ReactAndroid | ||
ReactCommon | ||
babel-preset | ||
blog | ||
bots | ||
danger | ||
docs | ||
flow | ||
gradle/wrapper | ||
jest | ||
keystores | ||
lib | ||
local-cli | ||
react-native-cli | ||
react-native-git-upgrade | ||
scripts | ||
third-party-podspecs | ||
website | ||
.buckconfig | ||
.buckjavaargs | ||
.editorconfig | ||
.eslintignore | ||
.eslintrc | ||
.flowconfig | ||
.gitattributes | ||
.gitignore | ||
.npmignore | ||
.travis.yml | ||
CONTRIBUTING.md | ||
DockerTests.md | ||
Jenkinsfile | ||
LICENSE | ||
LICENSE-docs | ||
PATENTS | ||
README.md | ||
React.podspec | ||
Releases.md | ||
Windows | ||
breaking-changes.md | ||
build.gradle | ||
circle.yml | ||
cli.js | ||
gradlew | ||
gradlew.bat | ||
jest-preset.json | ||
package.json | ||
react.gradle | ||
rn-cli.config.js | ||
rn-get-polyfills.js | ||
runXcodeTests.sh | ||
settings.gradle | ||
setupBabel.js |
README.md
React Native ·
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 website’s documentation is divided into multiple sections.
- There are Guides that discuss topics like debugging, integrating with existing apps, and the gesture responder system.
- The Components section covers React components such as
View
andButton
. - The APIs section covers other libraries like Animated and StyleSheet that aren’t React components themselves.
- Finally, React Native provides a small number of Polyfills that offer web-like APIs.
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.
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 is BSD licensed. We also provide an additional patent grant.
React documentation is Creative Commons licensed.