mirror of
https://github.com/zhigang1992/react-native.git
synced 2026-06-16 11:59:48 +08:00
* Separate Out Core Components Into Individual Parts Summary: Will create new issue to add more information to the `Components` section of the Tutorial since that was gutted by this change. Fixes #8156 Closes https://github.com/facebook/react-native/pull/8256 Differential Revision: D3459601 Pulled By: JoelMarcey fbshipit-source-id: 4038afc463bffcf8efda36d29bc7c443bbc8f4bd * Cleanup troubleshooting and debugging docs. Summary: This is a followup to #8010. Troubleshooting has been updated to list only those issues that may affect a user that is setting up their environment. Any issues related to day to day use have been moved or merged into a more relevant doc. Closes https://github.com/facebook/react-native/pull/8254 Reviewed By: caabernathy Differential Revision: D3459018 Pulled By: JoelMarcey fbshipit-source-id: dd76097af34bd33dda376fab39fb0f71061ef3e4 * Remove survey link Summary: We have enough responses now and we are in the lockdown for improving the documentation. We can add another "did we improve?" survey after lockdown sometime. Closes https://github.com/facebook/react-native/pull/8260 Differential Revision: D3463284 Pulled By: JoelMarcey fbshipit-source-id: f2d585a8aa6308de0cce0bea3974b1e7f14d5a6f * Add docs to show how to select specific simulator. Summary: Add a message to let people know they can use the `--simulator` flag to run their apps on different simulators instead of the default "iPhone 6" Closes https://github.com/facebook/react-native/pull/8078 Differential Revision: D3464912 Pulled By: JoelMarcey fbshipit-source-id: b59d5061d2b3501618602932fcc285bac99b7573 * Add ScrollView to Basics docs Summary: Add basic information about the generic `ScrollView` -- talk a bit about how it renders elements and a quick compare against something like a `ListView`. Provide a simple example. Fixes #8261 Closes https://github.com/facebook/react-native/pull/8266 Differential Revision: D3465105 Pulled By: JoelMarcey fbshipit-source-id: 3a2e1eac6e877669763fc6b8bb0fc78ebe870ab1 * Improve autogen for reference docs including jsdoc support Summary: As part of improving the API and Component reference docs #8154 this pull request adds the following: - jsdoc support for API docs. See the AlertIOS changes as an example. - type definitions support and added to both API and Component docs. This is supported via react-docgen and jsdoc. - better formatting of method properties (now shown in a table). FYI, API and Component docs were previously generated in two different ways. Components were using react-docgen and that basically remains as-is. APIs were using custom parsing code and that's been switched to use a jsdoc parser + react-docgen as an option for typedefs (it could also use the jsdoc parser). Two docs have been updated to showcase how we'd like the new docs to look: - AlertIOS (API): showing method parameters, examples, typedefs, more details overall. - Statusbar (Component): showing method parameters, typedefs, more details overall. **Note**: To convert new API docs to use the new format, add `jsdoc` to the initial file comment. C Closes https://github.com/facebook/react-native/pull/8196 Differential Revision: D3465037 Pulled By: lacker fbshipit-source-id: 78415d44bc5be02db802f5b1f7a0b249689abdf7 * overhaul showcase Summary: The motivation is that the showcase is becoming far too large to be useful. I filtered the apps for, basically, "apps that have some sort of interesting news coverage or technical blog post about them". The UI is a bit updated to also mention something about the information link. I also added the FB app itself. Closes https://github.com/facebook/react-native/pull/8263 Differential Revision: D3463856 Pulled By: JoelMarcey fbshipit-source-id: cdd309ba85edca417868f14dee7c772f73af654b * New React Native Landing Page Summary: The motivation is that we haven't changed the copy on the initial React Native landing page since launching, and we have a much clearer view of the React Native value prop now. Themes: 1. React Native is like React but for mobile apps 2. A React Native app is a "real native app" 3. Development is fast 4. You can drop down to normal native development if you need Closes https://github.com/facebook/react-native/pull/8291 Differential Revision: D3466855 Pulled By: JoelMarcey fbshipit-source-id: d1a5035640bcd795704d5f830b79e7c3d2e3ab02 * Move Videos and Newsletter to Support Summary: Simplify the sidebar. We have Twitter feed in support. These have a community feel as well. Closes https://github.com/facebook/react-native/pull/8287 Differential Revision: D3467042 Pulled By: lacker fbshipit-source-id: 60749d0cb31f284dae7c5402bfcde7b4d01aa32f * Include info about console.log Summary: I spent so much time trying to optimize my JS without noticing this. Closes https://github.com/facebook/react-native/pull/8285 Differential Revision: D3468707 fbshipit-source-id: bd5ff38ca2501891318b4be3c75bdaa10a4c64da * Add a new Handling Touches guide Summary: The new Handling Touches guide provides an overall view of how touches can be handled. It is meant to be a higher level discussion of basic touch handling, e.g. "how do I implement a button?". The existing Gesture Responder System guide has been moved to the end of the docs and is still available for reference when building custom gesture handlers. Reference: #8160  Closes https://github.com/facebook/react-native/pull/8299 Differential Revision: D3469681 Pulled By: JoelMarcey fbshipit-source-id: 3bc18e759b26c2d5c141b626acb433c5e973cef0 * Remove Polyfills section from sidebar Summary: Some of these will be in basics, guides and apis instead. One less layer of confusion. > Note: APIs are not totally alphabetical any longer -- but neither were Polyfills. We can fix that in `extractDocs.js` maybe. But not worth doing in this pull request, imho. Closes https://github.com/facebook/react-native/pull/8293 Differential Revision: D3469684 Pulled By: JoelMarcey fbshipit-source-id: 4f7830ca10b8e4406df9cec8bf13ff150e355250 * Docs: Basic Components Update Summary: This is an improvement to basic components docs. * I updated the basic components example code to better render components on iOS (added paddingTop). * I also modified the code to allow reader to easily copy, paste, and then run the code in their project if they followed the 'Getting Started' quick start guide. * I also added additional copy to clarify suggested usage/guidelines. Closes https://github.com/facebook/react-native/pull/8292 Differential Revision: D3469943 Pulled By: JoelMarcey fbshipit-source-id: 21ff6ee13b59741c43d80aab68a38aace0fbfca6 * Add react-native-web-player to core components docs Summary: This PR adds the interactive [React Native Web Player](http://dabbott.github.io/react-native-web-player/) to the docs. The web player is an embeddable iframe which runs React Native code using components from [react-native-web](https://github.com/necolas/react-native-web). For now, it's primarily for educational purposes, since only the basic components are implemented. Some details: - The iframe is loaded from MaxCDN using rawgit, locked down to a git tag. - Asset paths (i.e. images) are resolved relative to `//facebook.github.io/react-native/` - When viewed on mobile, it falls back to the syntax-highlighted code blocks. The WebPlayer can be inserted into markdown by using the fences: ``` ```ReactNativeWebPlayer import ... AppRegistry.registerComponent ... `` ` ```  I didn't actually add the WebPlayer to any docs pages in this PR. That we c Closes https://github.com/facebook/react-native/pull/8328 Differential Revision: D3471527 Pulled By: lacker fbshipit-source-id: 704da41cd77e08c7e2bc820557a74d36e88e8eb7 * More Resources doc, updating Support doc and quickstart too Summary: TLDR even more docs changes So I created a More Resources doc that aggregates the high-quality-but-off-site stuff. Let's try to put more outlinks there. Also I removed the stuff on Support that was not support, and some misc changes to clean stuff up. Closes https://github.com/facebook/react-native/pull/8329 Differential Revision: D3471669 Pulled By: JoelMarcey fbshipit-source-id: 54edd543ced1b3a8f3d0baca5475ac96bae6e487 * Add React Native Web Player to most component basics Summary: > ListView is not supported by React Native Web as of yet, so it will not have it. Closes https://github.com/facebook/react-native/pull/8331 Differential Revision: D3472019 Pulled By: lacker fbshipit-source-id: e5fb430b6c8f4d437943c159beb00b9d9252c92d * Update Navigator component doc Summary: Related to #8203 to update the Navigator component reference doc. **Test plan (required)** Started up the website and checked: http://localhost:8079/react-native/docs/navigator.html  **Note** The code is not Flow-ified so depended on jsdoc formatting to get the method parameter types. There's a current issue with handling optional types via react-docgen which parses components. There's an open PR to look into this: https://github.com/reactjs/react-docgen/pull/89. When that's resolved the `replaceAtIndex` method parameter type that's documented for `cb` needs to be updated to make it optional. Closes https://github.com/facebook/react-native/pull/8318 Differential Revision: D3471185 Pulled By: JoelMarcey fbshipit-source-id: 99f85ee2ab00dc200cf2812cce5b3ccec743d6a0 * fix Firefox bug Summary: The motivation is that the getting started page was not working in some cases in Firefox. This line of code appears to be at best a no-op, at worst fails in Firefox, since "event" is undefined. Closes https://github.com/facebook/react-native/pull/8335 Differential Revision: D3473333 Pulled By: JoelMarcey fbshipit-source-id: 40581e83126675aa072c6ee25609cfb787015ce7 * Fix guides docs to es2015 classes and remove flowtype from Animation example Summary: 1. Animation guide page is the only place where Flowtype is used, it would be better to remove it to prevent some confusion. 2. ES2015 classes in guidelines docs pages and fixed some typos **Test plan (required)** Should i write any tests for this? Closes https://github.com/facebook/react-native/pull/8339 Differential Revision: D3474192 Pulled By: bestander fbshipit-source-id: 5531d1e399eaed0952732ac2e0bd1effc72d00a8 * Update Views API documentation Summary: Ensure all `props` have documentation. Add more details to current `props`. Provide more information to the API in general. > Would like to try to integrate the React Native Web Player for the initial > example, but not right now. Closes https://github.com/facebook/react-native/pull/8341 Differential Revision: D3475105 Pulled By: caabernathy fbshipit-source-id: 00ad30b2359831740715517278bec1d0231e089d * Fixes #8252: Document how to connect to a non-default packager port o… Summary: Added some documentation to the `RunningOnDeviceAndroid.md` with screenshots to set custom port Closes https://github.com/facebook/react-native/pull/8355 Differential Revision: D3475846 Pulled By: mkonicek fbshipit-source-id: 73675b19e2bb93c859bda239f228da0883f0e305 * Add docs pages for basics: Dimensions and Layout Summary: These pages should sufficiently give a beginner enough information to make most layouts in React Native. They should go after the basics-style page, whenever that is ready. Having a single page for Layout was too much, so I split it into two: Dimensions and Layout.   lacker Closes https://github.com/facebook/react-native/pull/8364 Differential Revision: D3477147 Pulled By: lacker fbshipit-source-id: 1ef31ac0a64e43166a7581b38fa8263282672eeb * ES6-ify ListView Basics Summary: Fixes #8184 Closes https://github.com/facebook/react-native/pull/8370 Differential Revision: D3477196 Pulled By: caabernathy fbshipit-source-id: 929f84b3f8edaf03f918bb04fb9dbb48b4884b18 * Fix nits in update View API documentation Summary: Ref comments in #8341 Ref #8203 Closes https://github.com/facebook/react-native/pull/8361 Differential Revision: D3477174 Pulled By: caabernathy fbshipit-source-id: 495011c2d370d06d355e966d6ba2c52880146183 * ES6-ify ScrollView basics Summary: Closes https://github.com/facebook/react-native/pull/8368 Differential Revision: D3477381 Pulled By: caabernathy fbshipit-source-id: 0c43a9b8309db8f268a2776ebff2b4e52df559df * ES6-ify View Basics Summary: Closes https://github.com/facebook/react-native/pull/8366 Differential Revision: D3477409 Pulled By: caabernathy fbshipit-source-id: 5906e8dffc7884a6ed527fada5f907702a72c08f * ES6-ify Image Basics Summary: Closes https://github.com/facebook/react-native/pull/8365 Differential Revision: D3477411 Pulled By: caabernathy fbshipit-source-id: 26214fcf13c9e1352e198f34fcd6f5e88f1fe2da * ES6-ify TextInput Basics Summary: Closes https://github.com/facebook/react-native/pull/8367 Differential Revision: D3477404 Pulled By: caabernathy fbshipit-source-id: 16c279853b5c7a2d24033ef0d987da52dd148b24 * ES6-ify Text Basics Summary: Closes https://github.com/facebook/react-native/pull/8363 Differential Revision: D3477431 Pulled By: caabernathy fbshipit-source-id: 86ee5efb84e50609fbfae82102b1dc61fea69f05 * Update NavigatorIOS component doc Summary: Reference: #8203 Changes made: - Added more to the intro section and updated the intro examples to ES6 - Added more details to prop explanations - Added parameter descriptions for methods **Test plan (required)** Ran the website locally and checked: http://localhost:8079/react-native/docs/navigatorios.html  Closes https://github.com/facebook/react-native/pull/8334 Differential Revision: D3476066 Pulled By: JoelMarcey fbshipit-source-id: 9fcefe3f9d59008d8c72683c57cb004d1f185f62 * Update webview doc Summary: Reference: #8203 Changes made: Added a webview example to the intro section Added more details to prop explanations Test plan (required) Ran the website locally and checked: http://localhost:8079/react-native/docs/webview.html  Closes https://github.com/facebook/react-native/pull/8372 Differential Revision: D3477685 Pulled By: JoelMarcey fbshipit-source-id: a624f5c6c12a8367aea2a6e7c2e520da7a074bbd * Move everything out of Known Issues and into more appropriate locations. Summary: Two of the known issues have been moved to the issue tracker: * #8315 * #8316 Others have been moved into more appropriate locations, such as the `TextInput` issue to the API doc itself, and the React debugging issue to the Debugging doc. The Android-specific compatibility concerns have been dropped entirely as it does not seem like people would find these in the docs. Closes https://github.com/facebook/react-native/pull/8321 Differential Revision: D3477999 Pulled By: JoelMarcey fbshipit-source-id: dfffc9910ebf5514eb14c6aa8a9a3e70761db874 * Make a new "Style" doc that's in The Basics and uses the RNWP Summary: The example uses StyleSheet.create and also arrays-of-styles. I think this covers everything the old one did, but in simple-enough-for-the-basics form, so I removed the old one. I also reordered so that "Style -> Dimensions -> Layout" is the flow for learning "Styley" things. Closes https://github.com/facebook/react-native/pull/8379 Differential Revision: D3478384 Pulled By: caabernathy fbshipit-source-id: 158f0f0367c8eb8b2b24feda0d8d7a533fd7af4d * Add `extends Component` to Dimensions and Layout Basics Examples Summary: It works without out the `extends`, but I do not really understand why, unless there is some magic implicit `extends` if you don't put it and you call `registerComponent`. But, I figure we should be explicit unless there is a good reason not to be. Closes https://github.com/facebook/react-native/pull/8377 Differential Revision: D3478950 Pulled By: JoelMarcey fbshipit-source-id: 05ea4367c3c8c34aea6c092639ee51d8761bca3f * Bring out prop descriptions, for Flexbox Summary: For Flexbox API docs would like to tease out the prop descriptions. This PR makes that feasible by exposing the description for style. **Test plan (required)** 1. Temporarily modified the flexbox source doc: Libraries/StyleSheet/LayoutPropTypes.js to add a description. 2. Checked it out on local webpage: http://localhost:8079/react-native/docs/flexbox.html  Closes https://github.com/facebook/react-native/pull/8382 Differential Revision: D3478796 Pulled By: lacker fbshipit-source-id: 49f3b7876ff1ccec9ee837921a78ee0dfb915453 * Update web player in docs for custom registerComponent names Summary: In the web player in the docs, allows `AppRegistry.registerComponent('name', App)` to use *anything* for `'name'`. It is ignored by the web player - last registration wins. Closes https://github.com/facebook/react-native/pull/8383 Differential Revision: D3478922 Pulled By: JoelMarcey fbshipit-source-id: 3d1d96e0ad41216d29134ba384896e86d0cd2b32 * Networking Guide Summary: Simplified Networking Guide, based on the old Network polyfill doc. This guide strongly recommends using fetch, while still informing the user about React Native's support for other libraries. In order to provide an actual working networking example, a `movies.json` file is added at the root of the site, allowing the user to fetch a small blob of JSON: ``` fetch('http://facebook.github.io/react-native/movies.json') ```  Closes https://github.com/facebook/react-native/pull/8381 Differential Revision: D3479018 Pulled By: lacker fbshipit-source-id: 1f2078bf2414a13f7f77d5af55b08948909093a3 * Move Component Embedded Simulator next to its example Summary: Right now the embedded simulator is always at the top right corner. This can be confusing as to what code is associated with the simulation. So, move the simulator next to its actual code. This has the added benefit of allowing us to use the React Native Web Player for the simpler examples in the components. Closes https://github.com/facebook/react-native/pull/8384 Differential Revision: D3479056 Pulled By: bestander fbshipit-source-id: f400d8387ec771b94d5e798c1e955b25f9a0f1bf * fix bugs on landing page code, make the url an easter egg Summary: This is just improving a bit of lameness on the homepage - Devin pointed out the <>'s don't work within a Text tag, so I removed them, and someone else pointed out that nonexistent fake urls are suboptimal, so I improved that too. Closes https://github.com/facebook/react-native/pull/8387 Differential Revision: D3479087 Pulled By: JoelMarcey fbshipit-source-id: 45a2d21a9073b58b869e8b344550c28f849e0185 * Api documentation update for modal.js Summary: Related to #8203 to update the Modal API reference doc. **Test plan (required)** Started up the website and checked: http://localhost:8079/react-native/docs/modal.html  **Note, copied from a previous PR** The code is not Flow-ified so depended on jsdoc formatting to get the method parameter types. There's a current issue with handling optional types via react-docgen which parses components. There's an open PR to look into this: https://github.com/reactjs/react-docgen/pull/89. When that's resolved the `replaceAtIndex` method parameter type that's documented for `cb` needs to be updated to make it optional. Closes https://github.com/facebook/react-native/pull/8375 Differential Revision: D3479536 Pulled By: caabernathy fbshipit-source-id: de2db3aa221e4adce0c0c5f3d94a1fad528a60da * Update MapView doc Summary: Reference: #8203 Changes made: - Added a MapView example to the intro section - Added more details to prop explanations - Added more info to an exported type, even if it's not used anywhere I can see - Removed mention of ios platform in props. Left an android one in there as I didn't want to touch code. **Test plan (required)** Ran the website locally and checked: http://localhost:8079/react-native/docs/mapview.html  Closes https://github.com/facebook/react-native/pull/8389 Differential Revision: D3481609 Pulled By: JoelMarcey fbshipit-source-id: 71e35ce49193dc09d40546ff16bc48559135d63f * Accessing console logs Summary: Instructions for accessing the output of a `console.log`.  Closes https://github.com/facebook/react-native/pull/8323 Differential Revision: D3480718 Pulled By: JoelMarcey fbshipit-source-id: 4185d2e730277b8ad986d3c8904420e7ae1ceb21 * Add Navigation Overview Summary: Initial stab at writing a high level guide on navigation. Its main focus is on Navigator due to it being cross-platform and fairly simple to use. This guide should be expanded to cover tabbed applications in a future pull request. The Navigation (Experimental) section will be similarly expanded upon as the API stabilizes.  Closes https://github.com/facebook/react-native/pull/8390 Differential Revision: D3480304 Pulled By: caabernathy fbshipit-source-id: 280da9185fca295bc107a2df20106c783b461be7 * Update AsyncStorage doc Summary: Relates to #8203 for AsyncStorage API update. - Added a small example to the intro section. - Added jsdoc format tags to show up class description, parameter descriptions. - Word-smithed many of the method descriptions. I also made a bug fix to the autogen. It wasn't handling the scenario where a method may have no parameters. **Test plan (required)** Wrote a small sample app to test the snippet added to the intro section. Ran website locally: http://localhost:8079/react-native/docs/asyncstorage.html  Ran changed files through the linter. Closes https://github.com/facebook/react-native/pull/8396 Differential Revision: D3481783 Pulled By: JoelMarcey fbshipit-source-id: ebc4b9695482ada8a3455e621534d2a7fb11edf4 * Fix errors related to typehint when generating docs Summary: After pulling in AsyncStorage doc changes, getting typehint errors when running docs. This fixes that issue. **Test plan (required)** Opened http://localhost:8079/react-native/index.html Clicked around. No errors. Also successfully ran: ``` node server/generate.js ``` Closes https://github.com/facebook/react-native/pull/8412 Differential Revision: D3482007 Pulled By: JoelMarcey fbshipit-source-id: 7b0da2b2b38fd1f1bdec1b7c810ee70c536dd2bb * Update Image API Summary: - Provide runnable examples - Add more details to properties and jsdoc-ify the methods Ref #8203 Closes https://github.com/facebook/react-native/pull/8413 Differential Revision: D3482168 Pulled By: caabernathy fbshipit-source-id: 04fce5133317af282cced5850a53858e3f5b72f2 * Replace NavigatorComparison with the new Navigation guide. Summary: Several external sites link back to docs/navigator-comparison.html when talking about React Native's navigation. The Navigation guide added in #8390 is meant to replace this content, but it was added at docs/navigation.html. This pull request removes the comparison guide and replaces it with the Navigation guide's content. There is no content update in this PR. For review purposes, note that the next link from the previous document (JS Environment) has been updated to point to navigator-comparison, and the content of the Navigation guide remain unchanged from #8390. Closes https://github.com/facebook/react-native/pull/8417 Differential Revision: D3482273 Pulled By: caabernathy fbshipit-source-id: 9e04e11a5829d48541f8612fb65c01fe319e768b * Overhaul the Flexbox documentation Summary: Closes https://github.com/facebook/react-native/pull/8395 Differential Revision: D3482652 Pulled By: lacker fbshipit-source-id: 0bf8955341221b74f69ba24dcf5ab332c910a52c * Update TextInput API Summary: - Make the examples runnable (both copy/paste and with the web player) - Add a bit more information in props where needed. Closes https://github.com/facebook/react-native/pull/8392 Differential Revision: D3482747 Pulled By: caabernathy fbshipit-source-id: 8f2d812efc1efb3f14db45b5c054ce0d5c14f5f5 * Make "The Basics" flow like a linear tutorial Summary: Closes https://github.com/facebook/react-native/pull/8429 Differential Revision: D3487369 Pulled By: lacker fbshipit-source-id: 59b32f2a2a67370192c91dc43da3d4b76a43b810 * map -> object Summary: Closes https://github.com/facebook/react-native/pull/8450 Differential Revision: D3488018 fbshipit-source-id: a30269c89e87b546f77da7a32b1c4c65d978459d * Make the method signatures stand out more Summary: And more delineated from other parts of the method information. Hopefully this makes it easier to parse through. Closes https://github.com/facebook/react-native/pull/8421 Differential Revision: D3488251 Pulled By: JoelMarcey fbshipit-source-id: 44f2ed00b16849396cac94fd46567eaab48c50f3 * Use npmcdn in docs instead of rawgit for web player Summary: Switch web player cdn to npmcdn per discussion with lacker. This will make the url agnostic to who owns the git repo. Closes https://github.com/facebook/react-native/pull/8426 Differential Revision: D3488755 Pulled By: lacker fbshipit-source-id: b54dd4428a48c8a5a15b0b38ee0564d119916f9b * Update instructions for pointing Gradle to Android SDK Summary: Closes #8439 Closes https://github.com/facebook/react-native/pull/8446 Differential Revision: D3489034 fbshipit-source-id: 7cb50a43e64e216512294eaec06690dc9f3d6895 * Update RunningOnDeviceAndroid.md Summary: Add note associating error message to "adb reverse" command. When I first ran a React Native app on my Android phone, I received a cryptic "bridge configuration isn't available" error. After some research, I discovered that the "adb reverse" command mentioned further down on the page resolved the problem. Closes https://github.com/facebook/react-native/pull/7725 Differential Revision: D3491577 Pulled By: JoelMarcey fbshipit-source-id: 34c580acd6bf3e7788b674bd0b41bc5a1023b010 * improve text input docs Summary: Not a big deal, I was just going through the tutorial trying to figure out which doc was the most boring, and improve it a bit. IMO now the example is slightly funnier, and it mentions onSubmitEditing which in practice is probably a more useful callback. Closes https://github.com/facebook/react-native/pull/8447 Differential Revision: D3491938 Pulled By: JoelMarcey fbshipit-source-id: 3bd0f5762dc4db4a85c9d5badb6c005f4b8c52f4 * Update Text Component Summary: This updates the documentation for the `Text` component itself and the embedded `Text.md` that goes with it. - React Native Web Player - Document all props - NOTE: I actually added a new prop to `Text` called `accessible` since it was set by default and thus shown in the Props list in the original documentation (but with an empty description). - Stylistic fixes Closes https://github.com/facebook/react-native/pull/8445 Differential Revision: D3493112 Pulled By: JoelMarcey fbshipit-source-id: b428d4eb09065db5c6cb1ae5524ad22084fd2a82 * Fix TextInput API update nits Summary: Ref:7e7c2b5d57 (r68444537)Ref:7e7c2b5d57 (r68444442)Closes https://github.com/facebook/react-native/pull/8476 Differential Revision: D3494641 Pulled By: JoelMarcey fbshipit-source-id: 9a75ff66ccb895deb2f5027bdffe5d5bfe898e41
774 lines
29 KiB
Markdown
774 lines
29 KiB
Markdown
---
|
|
id: integration-with-existing-apps
|
|
title: Integration With Existing Apps
|
|
layout: docs
|
|
category: Guides
|
|
permalink: docs/integration-with-existing-apps.html
|
|
next: colors
|
|
---
|
|
|
|
<div class="integration-toggler">
|
|
<style>
|
|
.integration-toggler a {
|
|
display: inline-block;
|
|
padding: 10px 5px;
|
|
margin: 2px;
|
|
border: 1px solid #05A5D1;
|
|
border-radius: 3px;
|
|
text-decoration: none !important;
|
|
}
|
|
.display-platform-objc .integration-toggler .button-objc,
|
|
.display-platform-swift .integration-toggler .button-swift,
|
|
.display-platform-android .integration-toggler .button-android {
|
|
background-color: #05A5D1;
|
|
color: white;
|
|
}
|
|
block { display: none; }
|
|
.display-platform-objc .objc,
|
|
.display-platform-swift .swift,
|
|
.display-platform-android .android {
|
|
display: block;
|
|
}</style>
|
|
<span>Platform:</span>
|
|
<a href="javascript:void(0);" class="button-objc" onclick="display('platform', 'objc')">Objective-C</a>
|
|
<a href="javascript:void(0);" class="button-swift" onclick="display('platform', 'swift')">Swift</a>
|
|
<a href="javascript:void(0);" class="button-android" onclick="display('platform', 'android')">Android</a>
|
|
</div>
|
|
|
|
<block class="android" />
|
|
|
|
> This section will be updated shortly showing an integration into a more real world application such as the 2048 app that was used for Objective-C and Swift.
|
|
|
|
<block class="objc swift android" />
|
|
|
|
## Key Concepts
|
|
|
|
React Native is great when you are starting a new mobile app from scratch. However, it also works well for adding a single view or user flow to existing native applications. With a few steps, you can add new React Native based features, screens, views, etc.
|
|
|
|
<block class="objc swift" />
|
|
|
|
The keys to integrating React Native components into your iOS application are to:
|
|
|
|
1. Understand what React Native components you want to integrate.
|
|
2. Create a `Podfile` with `subspec`s for all the React Native components you will need for your integration.
|
|
3. Create your actual React Native components in JavaScript.
|
|
4. Add a new event handler that creates a `RCTRootView` that points to your React Native component and its `AppRegistry` name that you defined in `index.ios.js`.
|
|
5. Start the React Native server and run your native application.
|
|
6. Optionally add more React Native components.
|
|
7. [Debug](/react-native/releases/next/docs/debugging.html).
|
|
8. Prepare for [deployment](/react-native/docs/running-on-device-ios.html) (e.g., via the `react-native-xcode.sh` script).
|
|
9. Deploy and Profit!
|
|
|
|
<block class="android" />
|
|
|
|
The keys to integrating React Native components into your iOS application are to:
|
|
|
|
1. Understand what React Native components you want to integrate.
|
|
2. Install `react-native` in your Android application root directory to create `node_modules/` directory.
|
|
3. Create your actual React Native components in JavaScript.
|
|
4. Add `com.facebook.react:react-native:+` and a `maven` pointing to the `react-native` binaries in `node_nodules/` to your `build.gradle` file.
|
|
4. Create a custom React Native specific `Activity` that creates a `ReactRootView`.
|
|
5. Start the React Native server and run your native application.
|
|
6. Optionally add more React Native components.
|
|
7. [Debug](/react-native/releases/next/docs/debugging.html).
|
|
8. [Prepare](/react-native/releases/next/docs/signed-apk-android.html) for [deployment](/react-native/docs/running-on-device-android.html).
|
|
9. Deploy and Profit!
|
|
|
|
<block class="objc swift android" />
|
|
|
|
## Prerequisites
|
|
|
|
<block class="android" />
|
|
|
|
The [Android Getting Started guide](/react-native/docs/getting-started.html) will install the appropriate prerequisites (e.g., `npm`) for React Native on the Android target platform and your chosen development environment.
|
|
|
|
<block class="objc swift" />
|
|
|
|
### General
|
|
|
|
First, follow the [Getting Started guide](/react-native/docs/getting-started.html) for your development environment and the iOS target platform to install the prerequisites for React Native.
|
|
|
|
### CocoaPods
|
|
|
|
[CocoaPods](http://cocoapods.org) is a package management tool for iOS and Mac development. We use it to add the actual React Native framework code locally into your current project.
|
|
|
|
```bash
|
|
$ sudo gem install cocoapods
|
|
```
|
|
|
|
> It is technically possible not to use CocoaPods, but this requires manual library and linker additions that overly complicates this process.
|
|
|
|
## Our Sample App
|
|
|
|
<block class="objc" />
|
|
|
|
Assume the [app for integration](https://github.com/JoelMarcey/iOS-2048) is a [2048](https://en.wikipedia.org/wiki/2048_(video_game) game. Here is what the main menu of the native application looks like without React Native.
|
|
|
|
<block class="swift" />
|
|
|
|
Assume the [app for integration](https://github.com/JoelMarcey/swift-2048) is a [2048](https://en.wikipedia.org/wiki/2048_(video_game) game. Here is what the main menu of the native application looks like without React Native.
|
|
|
|
<block class="objc swift" />
|
|
|
|

|
|
|
|
## Package Dependencies
|
|
|
|
React Native integration requires both the React and React Native node modules. The React Native Framework will provide the code to allow your application integration to happen.
|
|
|
|
|
|
### `package.json`
|
|
|
|
We will add the package dependencies to a `package.json` file. Create this file in the root of your project if it does not exist.
|
|
|
|
> Normally with React Native projects, you will put files like `package.json`, `index.ios.js`, etc. in the root directory of your project and then have your iOS specific native code in a subdirectory like `ios/` where your Xcode project is located (e.g., `.xcodeproj`).
|
|
|
|
Below is an example of what your `package.json` file should minimally contain.
|
|
|
|
> Version numbers will vary according to your needs. Normally the latest versions for both [React](https://github.com/facebook/react/releases) and [React Native](https://github.com/facebook/react/releases) will be sufficient.
|
|
|
|
<block class="objc" />
|
|
|
|
```bash
|
|
{
|
|
"name": "NumberTileGame",
|
|
"version": "0.0.1",
|
|
"private": true,
|
|
"scripts": {
|
|
"start": "node node_modules/react-native/local-cli/cli.js start"
|
|
},
|
|
"dependencies": {
|
|
"react": "15.0.2",
|
|
"react-native": "0.26.1"
|
|
}
|
|
}
|
|
```
|
|
|
|
<block class="swift" />
|
|
|
|
```bash
|
|
{
|
|
"name": "swift-2048",
|
|
"version": "0.0.1",
|
|
"private": true,
|
|
"scripts": {
|
|
"start": "node node_modules/react-native/local-cli/cli.js start"
|
|
},
|
|
"dependencies": {
|
|
"react": "15.0.2",
|
|
"react-native": "0.26.1"
|
|
}
|
|
}
|
|
```
|
|
|
|
<block class="objc swift" />
|
|
|
|
### Packages Installation
|
|
|
|
Install the React and React Native modules via the Node package manager. The Node modules will be installed into a `node_modules/` directory in the root of your project.
|
|
|
|
```bash
|
|
# From the directory containing package.json project, install the modules
|
|
# The modules will be installed in node_modules/
|
|
$ npm install
|
|
```
|
|
|
|
## React Native Framework
|
|
|
|
The React Native Framework was installed as Node module in your project [above](#package-dependencies). We will now install a CocoaPods `Podfile` with the components you want to use from the framework itself.
|
|
|
|
### Subspecs
|
|
|
|
Before you integrate React Native into your application, you will want to decide what parts of the React Native Framework you would like to integrate. That is where `subspec`s come in. When you create your `Podfile`, you are going to specify React Native library dependencies that you will want installed so that your application can use those libraries. Each library will become a `subspec` in the `Podfile`.
|
|
|
|
|
|
The list of supported `subspec`s are in [`node_modules/react-native/React.podspec`](https://github.com/facebook/react-native/blob/master/React.podspec). They are generally named by functionality. For example, you will generally always want the `Core` `subspec`. That will get you the `AppRegistry`, `StyleSheet`, `View` and other core React Native libraries. If you want to add the React Native `Text` library (e.g., for `<Text>` elements), then you will need the `RCTText` `subspec`. If you want the `Image` library (e.g., for `<Image>` elements), then you will need the `RCTImage` `subspec`.
|
|
|
|
#### Podfile
|
|
|
|
After you have used Node to install the React and React Native frameworks into the `node_modules` directory, and you have decided on what React Native elements you want to integrate, you are ready to create your `Podfile` so you can install those components for use in your application.
|
|
|
|
The easiest way to create a `Podfile` is by using the CocoaPods `init` command in the native iOS code directory of your project:
|
|
|
|
```bash
|
|
## In the directory where your native iOS code is located (e.g., where your `.xcodeproj` file is located)
|
|
$ pod init
|
|
```
|
|
|
|
The `Podfile` will be created and saved in the *iOS* directory (e.g., `ios/`) of your current project and will contain a boilerplate setup that you will tweak for your integration purposes. In the end, `Podfile` should look something similar to this:
|
|
|
|
<block class="objc" />
|
|
|
|
```
|
|
# The target name is most likely the name of your project.
|
|
target 'NumberTileGame' do
|
|
|
|
# Your 'node_modules' directory is probably in the root of your project,
|
|
# but if not, adjust the `:path` accordingly
|
|
pod 'React', :path => '../node_modules/react-native', :subspecs => [
|
|
'Core',
|
|
'RCTText',
|
|
'RCTWebSocket', # needed for debugging
|
|
# Add any other subspecs you want to use in your project
|
|
]
|
|
|
|
end
|
|
```
|
|
|
|
<block class="swift" />
|
|
|
|
```
|
|
source 'https://github.com/CocoaPods/Specs.git'
|
|
|
|
# Required for Swift apps
|
|
platform :ios, '8.0'
|
|
use_frameworks!
|
|
|
|
# The target name is most likely the name of your project.
|
|
target 'swift-2048' do
|
|
|
|
# Your 'node_modules' directory is probably in the root of your project,
|
|
# but if not, adjust the `:path` accordingly
|
|
pod 'React', :path => '../node_modules/react-native', :subspecs => [
|
|
'Core',
|
|
'RCTText',
|
|
'RCTWebSocket', # needed for debugging
|
|
# Add any other subspecs you want to use in your project
|
|
]
|
|
|
|
end
|
|
```
|
|
|
|
<block class="objc swift" />
|
|
|
|
#### Pod Installation
|
|
|
|
After you have created your `Podfile`, you are ready to install the React Native pod.
|
|
|
|
```bash
|
|
$ pod install
|
|
```
|
|
|
|
Your should see output such as:
|
|
|
|
```bash
|
|
Analyzing dependencies
|
|
Fetching podspec for `React` from `../node_modules/react-native`
|
|
Downloading dependencies
|
|
Installing React (0.26.0)
|
|
Generating Pods project
|
|
Integrating client project
|
|
Sending stats
|
|
Pod installation complete! There are 3 dependencies from the Podfile and 1 total pod installed.
|
|
```
|
|
|
|
<block class="swift" />
|
|
|
|
> If you get a warning such as "*The `swift-2048 [Debug]` target overrides the `FRAMEWORK_SEARCH_PATHS` build setting defined in `Pods/Target Support Files/Pods-swift-2048/Pods-swift-2048.debug.xcconfig`. This can lead to problems with the CocoaPods installation*", then make sure the `Framework Search Paths` in `Build Settings` for both `Debug` and `Release` only contain `$(inherited)`.
|
|
|
|
<block class="objc swift" />
|
|
|
|
## Code Integration
|
|
|
|
Now that we have a package foundation, we will actually modify the native application to integrate React Native into the application. For our 2048 app, we will add a "High Score" screen in React Native.
|
|
|
|
### The React Native component
|
|
|
|
The first bit of code we will write is the actual React Native code for the new "High Score" screen that will be integrated into our application.
|
|
|
|
#### Create a `index.ios.js` file
|
|
|
|
First, create an empty `index.ios.js` file. For ease, I am doing this in the root of the project.
|
|
|
|
> `index.ios.js` is the starting point for React Native applications on iOS. And it is always required. It can be a small file that `require`s other file that are part of your React Native component or application, or it can contain all the code that is needed for it. In our case, we will just put everything in `index.ios.js`
|
|
|
|
```bash
|
|
# In root of your project
|
|
$ touch index.ios.js
|
|
```
|
|
|
|
#### Add Your React Native Code
|
|
|
|
In your `index.ios.js`, create your component. In our sample here, we will add simple `<Text>` component within a styled `<View>`
|
|
|
|
```js
|
|
'use strict';
|
|
|
|
import React from 'react';
|
|
import {
|
|
AppRegistry,
|
|
StyleSheet,
|
|
Text,
|
|
View
|
|
} from 'react-native';
|
|
|
|
class RNHighScores extends React.Component {
|
|
render() {
|
|
var contents = this.props["scores"].map(
|
|
score => <Text key={score.name}>{score.name}:{score.value}{"\n"}</Text>
|
|
);
|
|
return (
|
|
<View style={styles.container}>
|
|
<Text style={styles.highScoresTitle}>
|
|
2048 High Scores!
|
|
</Text>
|
|
<Text style={styles.scores}>
|
|
{contents}
|
|
</Text>
|
|
</View>
|
|
);
|
|
}
|
|
}
|
|
|
|
const styles = StyleSheet.create({
|
|
container: {
|
|
flex: 1,
|
|
justifyContent: 'center',
|
|
alignItems: 'center',
|
|
backgroundColor: '#FFFFFF',
|
|
},
|
|
highScoresTitle: {
|
|
fontSize: 20,
|
|
textAlign: 'center',
|
|
margin: 10,
|
|
},
|
|
scores: {
|
|
textAlign: 'center',
|
|
color: '#333333',
|
|
marginBottom: 5,
|
|
},
|
|
});
|
|
|
|
// Module name
|
|
AppRegistry.registerComponent('RNHighScores', () => RNHighScores);
|
|
```
|
|
|
|
> `RNHighScores` is the name of your module that will be used when you add a view to React Native from within your iOS application.
|
|
|
|
## The Magic: `RCTRootView`
|
|
|
|
Now that your React Native component is created via `index.ios.js`, you need to add that component to a new or existing `ViewController`. The easiest path is to take is to optionally create an event path to your component and then add that component to an existing `ViewController`.
|
|
|
|
We will tie our React Native component with a new native view in the `ViewController` that will actually host it called `RCTRootView` .
|
|
|
|
### Create an Event Path
|
|
|
|
You can add a new link on the main game menu to go to the "High Score" React Native page.
|
|
|
|

|
|
|
|
#### Event Handler
|
|
|
|
We will now add an event handler from the menu link. A method will be added to the main `ViewController` of your application. This is where `RCTRootView` comes into play.
|
|
|
|
When you build a React Native application, you use the React Native packager to create an `index.ios.bundle` that will be served by the React Native server. Inside `index.ios.bundle` will be our `RNHighScore` module. So, we need to point our `RCTRootView` to the location of the `index.ios.bundle` resource (via `NSURL`) and tie it to the module.
|
|
|
|
We will, for debugging purposes, log that the event handler was invoked. Then, we will create a string with the location of our React Native code that exists inside the `index.ios.bundle`. Finally, we will create the main `RCTRootView`. Notice how we provide `RNHighScores` as the `moduleName` that we created [above](#the-react-native-component) when writing the code for our React Native component.
|
|
|
|
<block class="objc" />
|
|
|
|
First `import` the `RCTRootView` library.
|
|
|
|
```
|
|
#import "RCTRootView.h"
|
|
```
|
|
|
|
> The `initialProperties` are here for illustration purposes so we have some data for our high score screen. In our React Native component, we will use `this.props` to get access to that data.
|
|
|
|
```
|
|
- (IBAction)highScoreButtonPressed:(id)sender {
|
|
NSLog(@"High Score Button Pressed");
|
|
NSURL *jsCodeLocation = [NSURL
|
|
URLWithString:@"http://localhost:8081/index.ios.bundle?platform=ios"];
|
|
RCTRootView *rootView =
|
|
[[RCTRootView alloc] initWithBundleURL : jsCodeLocation
|
|
moduleName : @"RNHighScores"
|
|
initialProperties :
|
|
@{
|
|
@"scores" : @[
|
|
@{
|
|
@"name" : @"Alex",
|
|
@"value": @"42"
|
|
},
|
|
@{
|
|
@"name" : @"Joel",
|
|
@"value": @"10"
|
|
}
|
|
]
|
|
}
|
|
launchOptions : nil];
|
|
UIViewController *vc = [[UIViewController alloc] init];
|
|
vc.view = rootView;
|
|
[self presentViewController:vc animated:YES completion:nil];
|
|
}
|
|
```
|
|
|
|
> Note that `RCTRootView initWithURL` starts up a new JSC VM. To save resources and simplify the communication between RN views in different parts of your native app, you can have multiple views powered by React Native that are associated with a single JS runtime. To do that, instead of using `[RCTRootView alloc] initWithURL`, use [`RCTBridge initWithBundleURL`](https://github.com/facebook/react-native/blob/master/React/Base/RCTBridge.h#L93) to create a bridge and then use `RCTRootView initWithBridge`.
|
|
|
|
<block class="swift" />
|
|
|
|
First `import` the `React` library.
|
|
|
|
```
|
|
import React
|
|
```
|
|
|
|
> The `initialProperties` are here for illustration purposes so we have some data for our high score screen. In our React Native component, we will use `this.props` to get access to that data.
|
|
|
|
```
|
|
@IBAction func highScoreButtonTapped(sender : UIButton) {
|
|
NSLog("Hello")
|
|
let jsCodeLocation = NSURL(string: "http://localhost:8081/index.ios.bundle?platform=ios")
|
|
let mockData:NSDictionary = ["scores":
|
|
[
|
|
["name":"Alex", "value":"42"],
|
|
["name":"Joel", "value":"10"]
|
|
]
|
|
]
|
|
|
|
let rootView = RCTRootView(
|
|
bundleURL: jsCodeLocation,
|
|
moduleName: "RNHighScores",
|
|
initialProperties: mockData as [NSObject : AnyObject],
|
|
launchOptions: nil
|
|
)
|
|
let vc = UIViewController()
|
|
vc.view = rootView
|
|
self.presentViewController(vc, animated: true, completion: nil)
|
|
}
|
|
```
|
|
|
|
> Note that `RCTRootView bundleURL` starts up a new JSC VM. To save resources and simplify the communication between RN views in different parts of your native app, you can have multiple views powered by React Native that are associated with a single JS runtime. To do that, instead of using `RCTRootView bundleURL`, use [`RCTBridge initWithBundleURL`](https://github.com/facebook/react-native/blob/master/React/Base/RCTBridge.h#L93) to create a bridge and then use `RCTRootView initWithBridge`.
|
|
|
|
<block class="objc" />
|
|
|
|
> When moving your app to production, the `NSURL` can point to a pre-bundled file on disk via something like `[[NSBundle mainBundle] URLForResource:@"main" withExtension:@"jsbundle"];`. You can use the `react-native-xcode.sh` script in `node_modules/react-native/packager/` to generate that pre-bundled file.
|
|
|
|
<block class="swift" />
|
|
|
|
> When moving your app to production, the `NSURL` can point to a pre-bundled file on disk via something like `let mainBundle = NSBundle(URLForResource: "main" withExtension:"jsbundle")`. You can use the `react-native-xcode.sh` script in `node_modules/react-native/packager/` to generate that pre-bundled file.
|
|
|
|
<block class="objc swift" />
|
|
|
|
#### Wire Up
|
|
|
|
Wire up the new link in the main menu to the newly added event handler method.
|
|
|
|

|
|
|
|
> One of the easier ways to do this is to open the view in the storyboard and right click on the new link. Select something such as the `Touch Up Inside` event, drag that to the storyboard and then select the created method from the list provided.
|
|
|
|
## Test Your Integration
|
|
|
|
You have now done all the basic steps to integrate React Native with your current application. Now we will start the React Native packager to build the `index.ios.bundle` packager and the server running on `localhost` to serve it.
|
|
|
|
### App Transport Security
|
|
|
|
Apple has blocked implicit cleartext HTTP resource loading. So we need to add the following our project's `Info.plist` (or equivalent) file.
|
|
|
|
```xml
|
|
<key>NSAppTransportSecurity</key>
|
|
<dict>
|
|
<key>NSExceptionDomains</key>
|
|
<dict>
|
|
<key>localhost</key>
|
|
<dict>
|
|
<key>NSTemporaryExceptionAllowsInsecureHTTPLoads</key>
|
|
<true/>
|
|
</dict>
|
|
</dict>
|
|
</dict>
|
|
```
|
|
|
|
### Run the Packager
|
|
|
|
```bash
|
|
# From the root of your project, where the `node_modules` directory is located.
|
|
$ npm start
|
|
```
|
|
|
|
### Run the App
|
|
|
|
If you are using Xcode or your favorite editor, build and run your native iOS application as normal. Alternatively, you can run the app from the command line using:
|
|
|
|
```bash
|
|
# From the root of your project
|
|
$ react-native run-ios
|
|
```
|
|
|
|
In our sample application, you should see the link to the "High Scores" and then when you click on that you will see the rendering of your React Native component.
|
|
|
|
Here is the *native* application home screen:
|
|
|
|

|
|
|
|
Here is the *React Native* high score screen:
|
|
|
|

|
|
|
|
> If you are getting module resolution issues when running your application please see [this GitHub issue](https://github.com/facebook/react-native/issues/4968) for information and possible resolution. [This comment](https://github.com/facebook/react-native/issues/4968#issuecomment-220941717) seemed to be the latest possible resolution.
|
|
|
|
### See the Code
|
|
|
|
<block class="objc" />
|
|
|
|
You can examine the code that added the React Native screen on [GitHub](https://github.com/JoelMarcey/iOS-2048/commit/9ae70c7cdd53eb59f5f7c7daab382b0300ed3585).
|
|
|
|
<block class="swift" />
|
|
|
|
You can examine the code that added the React Native screen on [GitHub](https://github.com/JoelMarcey/swift-2048/commit/13272a31ee6dd46dc68b1dcf4eaf16c1a10f5229).
|
|
|
|
<block class="android" />
|
|
|
|
## Add JS to your app
|
|
|
|
In your app's root folder, run:
|
|
|
|
$ npm init
|
|
$ npm install --save react-native
|
|
$ curl -o .flowconfig https://raw.githubusercontent.com/facebook/react-native/master/.flowconfig
|
|
|
|
This creates a node module for your app and adds the `react-native` npm dependency. Now open the newly created `package.json` file and add this under `scripts`:
|
|
|
|
"start": "node node_modules/react-native/local-cli/cli.js start"
|
|
|
|
Copy & paste the following code to `index.android.js` in your root folder — it's a barebones React Native app:
|
|
|
|
```js
|
|
'use strict';
|
|
|
|
import React from 'react';
|
|
import {
|
|
AppRegistry,
|
|
StyleSheet,
|
|
Text,
|
|
View
|
|
} from 'react-native';
|
|
|
|
class HelloWorld extends React.Component {
|
|
render() {
|
|
return (
|
|
<View style={styles.container}>
|
|
<Text style={styles.hello}>Hello, World</Text>
|
|
</View>
|
|
)
|
|
}
|
|
}
|
|
var styles = StyleSheet.create({
|
|
container: {
|
|
flex: 1,
|
|
justifyContent: 'center',
|
|
},
|
|
hello: {
|
|
fontSize: 20,
|
|
textAlign: 'center',
|
|
margin: 10,
|
|
},
|
|
});
|
|
|
|
AppRegistry.registerComponent('HelloWorld', () => HelloWorld);
|
|
```
|
|
|
|
## Prepare your current app
|
|
|
|
In your app's `build.gradle` file add the React Native dependency:
|
|
|
|
compile "com.facebook.react:react-native:+" // From node_modules
|
|
|
|
In your project's `build.gradle` file add an entry for the local React Native maven directory:
|
|
|
|
```
|
|
allprojects {
|
|
repositories {
|
|
...
|
|
maven {
|
|
// All of React Native (JS, Android binaries) is installed from npm
|
|
url "$rootDir/node_modules/react-native/android"
|
|
}
|
|
}
|
|
...
|
|
}
|
|
```
|
|
|
|
Next, make sure you have the Internet permission in your `AndroidManifest.xml`:
|
|
|
|
<uses-permission android:name="android.permission.INTERNET" />
|
|
|
|
This is only really used in dev mode when reloading JavaScript from the development server, so you can strip this in release builds if you need to.
|
|
|
|
## Add native code
|
|
|
|
You need to add some native code in order to start the React Native runtime and get it to render something. To do this, we're going to create an `Activity` that creates a `ReactRootView`, starts a React application inside it and sets it as the main content view.
|
|
|
|
```java
|
|
public class MyReactActivity extends Activity implements DefaultHardwareBackBtnHandler {
|
|
private ReactRootView mReactRootView;
|
|
private ReactInstanceManager mReactInstanceManager;
|
|
|
|
@Override
|
|
protected void onCreate(Bundle savedInstanceState) {
|
|
super.onCreate(savedInstanceState);
|
|
|
|
mReactRootView = new ReactRootView(this);
|
|
mReactInstanceManager = ReactInstanceManager.builder()
|
|
.setApplication(getApplication())
|
|
.setBundleAssetName("index.android.bundle")
|
|
.setJSMainModuleName("index.android")
|
|
.addPackage(new MainReactPackage())
|
|
.setUseDeveloperSupport(BuildConfig.DEBUG)
|
|
.setInitialLifecycleState(LifecycleState.RESUMED)
|
|
.build();
|
|
mReactRootView.startReactApplication(mReactInstanceManager, "HelloWorld", null);
|
|
|
|
setContentView(mReactRootView);
|
|
}
|
|
|
|
@Override
|
|
public void invokeDefaultOnBackPressed() {
|
|
super.onBackPressed();
|
|
}
|
|
}
|
|
```
|
|
|
|
> A `ReactInstanceManager` can be shared amongst multiple activities and/or fragments. You will want to make your own `ReactFragment` or `ReactActivity` and have a singleton *holder* that holds a `ReactInstanceManager`. When you need the `ReactInstanceManager` (e.g., to hook up the `ReactInstanceManager` to the lifecycle of those Activities or Fragments) use the one provided by the singleton.
|
|
|
|
Next, we need to pass some activity lifecycle callbacks down to the `ReactInstanceManager`:
|
|
|
|
```java
|
|
@Override
|
|
protected void onPause() {
|
|
super.onPause();
|
|
|
|
if (mReactInstanceManager != null) {
|
|
mReactInstanceManager.onHostPause();
|
|
}
|
|
}
|
|
|
|
@Override
|
|
protected void onResume() {
|
|
super.onResume();
|
|
|
|
if (mReactInstanceManager != null) {
|
|
mReactInstanceManager.onHostResume(this, this);
|
|
}
|
|
}
|
|
|
|
@Override
|
|
protected void onDestroy() {
|
|
super.onDestroy();
|
|
|
|
if (mReactInstanceManager != null) {
|
|
mReactInstanceManager.onHostDestroy();
|
|
}
|
|
}
|
|
```
|
|
|
|
We also need to pass back button events to React Native:
|
|
|
|
```java
|
|
@Override
|
|
public void onBackPressed() {
|
|
if (mReactInstanceManager != null) {
|
|
mReactInstanceManager.onBackPressed();
|
|
} else {
|
|
super.onBackPressed();
|
|
}
|
|
}
|
|
```
|
|
|
|
This allows JavaScript to control what happens when the user presses the hardware back button (e.g. to implement navigation). When JavaScript doesn't handle a back press, your `invokeDefaultOnBackPressed` method will be called. By default this simply finishes your `Activity`.
|
|
|
|
Finally, we need to hook up the dev menu. By default, this is activated by (rage) shaking the device, but this is not very useful in emulators. So we make it show when you press the hardware menu button:
|
|
|
|
```java
|
|
@Override
|
|
public boolean onKeyUp(int keyCode, KeyEvent event) {
|
|
if (keyCode == KeyEvent.KEYCODE_MENU && mReactInstanceManager != null) {
|
|
mReactInstanceManager.showDevOptionsDialog();
|
|
return true;
|
|
}
|
|
return super.onKeyUp(keyCode, event);
|
|
}
|
|
```
|
|
|
|
That's it, your activity is ready to run some JavaScript code.
|
|
|
|
## Run your app
|
|
|
|
To run your app, you need to first start the development server. To do this, simply run the following command in your root folder:
|
|
|
|
$ npm start
|
|
|
|
Now build and run your Android app as normal (e.g. `./gradlew installDebug`). Once you reach your React-powered activity inside the app, it should load the JavaScript code from the development server and display:
|
|
|
|

|
|
|
|
<script>
|
|
// Convert <div>...<span><block /></span>...</div>
|
|
// Into <div>...<block />...</div>
|
|
var blocks = document.getElementsByTagName('block');
|
|
for (var i = 0; i < blocks.length; ++i) {
|
|
var block = blocks[i];
|
|
var span = blocks[i].parentNode;
|
|
var container = span.parentNode;
|
|
container.insertBefore(block, span);
|
|
container.removeChild(span);
|
|
}
|
|
// Convert <div>...<block />content<block />...</div>
|
|
// Into <div>...<block>content</block><block />...</div>
|
|
blocks = document.getElementsByTagName('block');
|
|
for (var i = 0; i < blocks.length; ++i) {
|
|
var block = blocks[i];
|
|
while (block.nextSibling && block.nextSibling.tagName !== 'BLOCK') {
|
|
block.appendChild(block.nextSibling);
|
|
}
|
|
}
|
|
function display(type, value) {
|
|
var container = document.getElementsByTagName('block')[0].parentNode;
|
|
container.className = 'display-' + type + '-' + value + ' ' +
|
|
container.className.replace(RegExp('display-' + type + '-[a-z]+ ?'), '');
|
|
console.log(container.className);
|
|
event && event.preventDefault();
|
|
}
|
|
|
|
// If we are coming to the page with a hash in it (i.e. from a search, for example), try to get
|
|
// us as close as possible to the correct platform and dev os using the hashtag and block walk up.
|
|
var foundHash = false;
|
|
if (window.location.hash !== '' && window.location.hash !== 'content') { // content is default
|
|
var hashLinks = document.querySelectorAll('a.hash-link');
|
|
for (var i = 0; i < hashLinks.length && !foundHash; ++i) {
|
|
if (hashLinks[i].hash === window.location.hash) {
|
|
var parent = hashLinks[i].parentElement;
|
|
while (parent) {
|
|
if (parent.tagName === 'BLOCK') {
|
|
var targetPlatform = null;
|
|
// Could be more than one target platform, but just choose some sort of order
|
|
// of priority here.
|
|
|
|
// Target Platform
|
|
if (parent.className.indexOf('objc') > -1) {
|
|
targetPlatform = 'objc';
|
|
} else if (parent.className.indexOf('swift') > -1) {
|
|
targetPlatform = 'swift';
|
|
} else if (parent.className.indexOf('android') > -1) {
|
|
targetPlatform = 'android';
|
|
} else {
|
|
break; // assume we don't have anything.
|
|
}
|
|
// We would have broken out if both targetPlatform and devOS hadn't been filled.
|
|
display('platform', targetPlatform);
|
|
foundHash = true;
|
|
break;
|
|
}
|
|
parent = parent.parentElement;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
// Do the default if there is no matching hash
|
|
if (!foundHash) {
|
|
var isMac = navigator.platform === 'MacIntel';
|
|
display('platform', isMac ? 'objc' : 'android');
|
|
}
|
|
</script>
|