Commit Graph

29 Commits

Author SHA1 Message Date
Maxime Aoustin 6336e4d41e Update Podfile documentation for RN >= 0.42.0
Summary:
I've updated the documentation that gives an example of Podfile adding a note that from React Native 0.42.0, users have to explicitly include Yoga in their Podfile.

I didn't want to modify existing `Podfile` from this documentation because they refer to `Podfile` from existing projects that do not use RN 0.42.0. So I just added a note and an example to explain how to include Yoga.

This PR is to fix the following issue: https://github.com/facebook/react-native/issues/12670
Closes https://github.com/facebook/react-native/pull/12728

Differential Revision: D4716172

Pulled By: hramos

fbshipit-source-id: 12a6e61b0d426c776a7cc2dea3ac22a50ffe56ef
2017-03-15 14:21:18 -07:00
Hector Ramos c503dae446 Merge Android UI Performance into Performance doc, reorder sidebar
Summary:
Doing some cleanup in preparation for CRNA.
Recommend `FlatList` and React Navigation for perf.
Tag docs that may only apply to apps ejected from CRNA. Currently has no effect.
Closes https://github.com/facebook/react-native/pull/12692

Differential Revision: D4654077

Pulled By: hramos

fbshipit-source-id: 1245d80d66e37d9dca9e9daf23e8b93c65cd1bf7
2017-03-06 10:10:04 -08:00
Héctor Ramos dc520732e8 Update IntegrationWithExistingApps.md
Summary:
Just a little nit pick to add extra information to this doc. I spent a few hours trying to fix this problem because I had not placed the code in build.gradle correctly. I think this small addition would be useful to others.
Closes https://github.com/facebook/react-native/pull/12475

Differential Revision: D4608443

Pulled By: hramos

fbshipit-source-id: eb719d5cf9d905c4f043ec71f1a3e28e0219626e
2017-02-23 16:31:41 -08:00
Paul Mestemaker 8378f0f9f7 Ensure documentation has consistent relative links
Summary:
Explain the **motivation** for making this change. What existing problem does the pull request solve?

I had tried fixing a broken link in a previous commit (#11453). My commit was merged, but it did not resolve the underlying problem. I have looked into how links should be formed for the docs and have fixed the original problem as well as updated all other links to be consistent.

Previous link formats:

- /docs/sample.html <-- broken link
- sample.html <-- broken link
- https://facebook.github.io/react-native/docs/sample.html <-- works
- /react-native/docs/sample.html <-- works
- docs/sample.html <-- works (permalink format)

This PR updates all links to the permalink format.

**Test plan (required)**
I ran the website locally and manually tested half of the links in each category. They all worked.
```
$ cd website
$ npm install && npm start
```
Closes https://github.com/facebook/react-native/pull/12064

Differential Revision: D4489153

Pulled By: mkonicek

fbshipit-source-id: bf0231d941ba147317595c3b3466dc579a887169
2017-01-31 12:13:31 -08:00
Eric Vicenti 257794762e IntegrationWithExsistingApps Android Update
Summary:
Added permission code to handle the user permission accepted or denied cases which causes potential app crashing if not handled. Only a small piece of code added to the guide to resolve an issue I was facing with permission.

The app that I was testing following the guide available, it was crashing showing permission denied error on the android monitor, and there was no step for how to resolve the issue. So I tried out a solution so thought would share it on the official Guide to help people who are stuck with the same issue.
Closes https://github.com/facebook/react-native/pull/11687

Differential Revision: D4377882

Pulled By: ericvicenti

fbshipit-source-id: a7db104c7c1b7e1fb2590c83118715840c17927b
2017-01-03 11:28:33 -08:00
Abhijit Nukalapati db20b97dfb updating android docs to use the right methods in code snippets
Summary:
- Updating code snippets in the android integration docs which use methods that no longer exist in the [ReactInstanceManager](https://github.com/facebook/react-native/blob/master/ReactAndroid/src/main/java/com/facebook/react/ReactInstanceManager.java) class
Closes https://github.com/facebook/react-native/pull/11070

Differential Revision: D4220830

Pulled By: JoelMarcey

fbshipit-source-id: 0dfc49accc27feb42ac31fb50c887736e652ec1b
2016-11-22 11:13:30 -08:00
Zaan fa1f6fd543 Update IntegrationWithExistingApps.md
Summary:
DOCS
Android studio should be android section only
Closes https://github.com/facebook/react-native/pull/10984

Differential Revision: D4197586

Pulled By: JoelMarcey

fbshipit-source-id: 2fe3d737083f3ad301dbc39cdb4f8ff315370d76
2016-11-17 07:13:23 -08:00
Liam 7f6d435188 "this" not needed in mReactInstanceManager.onDestroy()
Summary:
Thanks for submitting a pull request! Please provide enough information so that others can review your pull request:

> **Unless you are a React Native release maintainer and cherry-picking an *existing* commit into a current release, ensure your pull request is targeting the `master` React Native branch.**

Explain the **motivation** for making this change. What existing problem does the pull request solve?

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

**Test plan (required)**

Demonstrate the code is solid. Example: The exact commands you ran and their output, screenshots / videos if the pull request changes UI.

Make sure tests pass on both Travis and Circle CI.

**Code formatting**

Look around. Match the style of the rest of the codebase. See also the simple [style guide](https://github.com/facebook/react-native/blob/master/CONTRIBUTING.md#style-guide).

For more info, see
Closes https://github.com/facebook/react-native/pull/10924

Differential Revision: D4181397

Pulled By: ericvicenti

fbshipit-source-id: e5c762937efba3bd65fbe00cc94678e8c1461659
2016-11-14 20:58:56 -08:00
Sandro Machado 100b27cc7a Add the overlay permission information
Summary:
If your current android application is targeting the android `api level 23` or greater, displaying the error view will cause a crash in the application. The crash only shows that the system cannot display the view.
Closes https://github.com/facebook/react-native/pull/10479

Differential Revision: D4167801

Pulled By: hramos

fbshipit-source-id: 5f7315038a8a4c36d1513173139d5c4cf50ea868
2016-11-11 10:58:55 -08:00
Héctor Ramos 72369ee4d2 Consolidate Running on Device (Android|iOS) Guides into one
Summary:
The RunningOnDeviceAndroid doc had some Linux-specific instructions that are not relevant to macOS/Windows users.
Closes https://github.com/facebook/react-native/pull/10726

Differential Revision: D4139089

Pulled By: JoelMarcey

fbshipit-source-id: cc57c1d7e3c9dec94e123c3597ac78b3efb15dd0
2016-11-06 21:13:32 -08:00
crismali d685620f31 Prevent escaped 'a' tag html from appearing in 'Integration With Exis…
Summary:
Explain the **motivation** for making this change. What existing problem does the pull request solve?

- Prevents unclickable, escaped HTML from appearing in the docs.

[Before](https://facebook.github.io/react-native/docs/integration-with-existing-apps.html#our-sample-app):
![screen shot 2016-11-01 at 2 45 14 pm](https://cloud.githubusercontent.com/assets/3209502/19904789/263a4080-a042-11e6-8d9e-f88d3f8e5a77.png)

After:
![screen shot 2016-11-01 at 2 45 29 pm](https://cloud.githubusercontent.com/assets/3209502/19904813/39a5dcf6-a042-11e6-9dfb-766af44a246c.png)
Closes https://github.com/facebook/react-native/pull/10685

Differential Revision: D4113084

Pulled By: hramos

fbshipit-source-id: 210cc97d8f53ee0ec7a26640d99c4dfedf7145b5
2016-11-01 15:13:39 -07:00
Gan Jian Wei c9d8e233aa Update IntegrationWithExistingApps.md for Swift 3
Summary:
Update integrating with existing Swift App code for Swift 3.
Closes https://github.com/facebook/react-native/pull/10547

Differential Revision: D4079631

Pulled By: lacker

fbshipit-source-id: 7a493ca7131a10a2466816b104b9cb4f1ff369f5
2016-10-25 18:43:44 -07:00
Kevin Lacker 5f15554100 Fix a typo
Summary:
node_nodules => node_modules
Closes https://github.com/facebook/react-native/pull/10529

Differential Revision: D4072000

Pulled By: JoelMarcey

fbshipit-source-id: dcac771c3b960330535c459ddcc9eb6b18a30841
2016-10-24 17:43:37 -07:00
Sandro Machado 43d79da5ba Add folder structure information
Summary:
Some tools, like `react-native-cli` only works correctly if the `android` and `iOS` projects respect the react native folders structure. Usually, when you are integrating react native with other existing projects, that is not the case. This note will help the developers to identify and avoid potential issues.
Closes https://github.com/facebook/react-native/pull/10480

Differential Revision: D4056046

Pulled By: JoelMarcey

fbshipit-source-id: ef8d75b338616b2319f7e0418a7bfcfa1a0604dc
2016-10-20 19:13:40 -07:00
Sandro Machado e2129aa454 Improve android integration documentation
Summary:
To access to the `DevSettingsActivity` it is required to declare the `Activity` in the `AndroidManifest.xml` or the application will crash every time the developer tries to access it.
Closes https://github.com/facebook/react-native/pull/10478

Differential Revision: D4050931

Pulled By: JoelMarcey

fbshipit-source-id: 4b587ab84375a6f08bc69e18d2cd00ae9dfa726d
2016-10-20 06:58:49 -07:00
Christoffer Bo Petersen 5d97f6df15 Update activity lifecycle callback example
Summary:
Updates the documentation for the the android life cycle methods, recent changes has deprecated

 `onHostPause()` for `onHostPause(Activity activity)`
 `onHostDestroy()` for `onHostDestroy(Activity activity)`

[deprecation commit](0b5c61250b)
Closes https://github.com/facebook/react-native/pull/10460

Differential Revision: D4044420

Pulled By: JoelMarcey

fbshipit-source-id: 54c5fc8fcd332235b6c0237a180e0c5bb2310a20
2016-10-19 09:43:37 -07:00
Sandro Machado 56ac2a45d7 Add the RCTNetwork to the podfile
Summary:
The pod `RCTNetwork` is missing from the `Podfile` documentation. Without it the view controller does not run.

This probably also closes #8449.
Closes https://github.com/facebook/react-native/pull/10389

Differential Revision: D4021432

Pulled By: JoelMarcey

fbshipit-source-id: 689ed540c6750bf4ccaee1e7943d9175ac50d6c5
2016-10-14 07:13:41 -07:00
Sandro Machado ae9cc004b9 Remove setUseOldBridge from the documentation
Summary:
This PR removes the `.setUseOldBridge(true)` from the documentation. The method was removed from the `ReactInstanceManager` class at [this](1a690d5674 (diff-dc0f3a09c238b372cb1c27aa5f7dcbce)) commit and currently it is not available.
Closes https://github.com/facebook/react-native/pull/10368

Differential Revision: D4016564

Pulled By: JoelMarcey

fbshipit-source-id: 0d9f83c1708dc85043d80a82ecd4fad6b9d42cf5
2016-10-13 12:13:46 -07:00
Nicolas Cuillery 179a651240 Use HTML for links including closing bracket
Summary:
The markdown parser (Marked) used by the docs doesn't handle links ending with a closing bracket. The result is a broken link in the [Integration With Existing Apps](http://facebook.github.io/react-native/docs/integration-with-existing-apps.html#our-sample-app) guide.

Using HTML makes the parser ignoring these links.

Note: this is a well-known issue of Marked: https://github.com/chjj/marked/issues/690
Note bis: The fix #9429 didn't solve the problem.
Closes https://github.com/facebook/react-native/pull/10225

Differential Revision: D3964341

fbshipit-source-id: 61564d1cbb632fa1f0c71e7c6cbdc0b9a200caa4
2016-10-03 16:13:33 -07:00
Joshua May 5d57368bb0 Docs fix: link for releases points to react-native repo
Summary:
Both of the links were pointing to the same (`react`) repo, but shouldn't have.

Obvious enough :)
Closes https://github.com/facebook/react-native/pull/9923

Differential Revision: D3870481

Pulled By: JoelMarcey

fbshipit-source-id: b35c963c65fd0b253d076d83a4a1276c134b81d2
2016-09-15 09:13:39 -07:00
Honza Kalfus 6cf7900030 Updated integration with existing apps for Android
Summary:
I updated the integration with existing apps guide for Android with more recent info based on my article: https://medium.com/jankalfus/how-to-integrate-react-native-into-an-existing-android-app-c8b93b881632#.1o1vouxbn

Somebody please check the grammar etc., I'm not a native speaker.

Ping satya164.
Closes https://github.com/facebook/react-native/pull/9644

Differential Revision: D3790845

fbshipit-source-id: c653f1aa8f92e09fa2bf1e9d50497ef7918d1d1d
2016-08-30 03:44:16 -07:00
Vikram Aravamudhan 6729df3f28 Add "npm i --save react" to Android docs
Summary:
This PR changes the docs for Android installation.

If you're a first time user and follow http://facebook.github.io/react-native/docs/integration-with-existing-apps.html, the react-enabled activity throws a red error screen with missing react module. `index.android.js` has `import React from 'react';`.
Closes https://github.com/facebook/react-native/pull/9614

Differential Revision: D3783092

Pulled By: javache

fbshipit-source-id: 5aef7cc1d47aa4702c854336f3670cdc47e10f86
2016-08-27 12:28:49 -07:00
Jonathan Chen 7ca3764eae Fix Wikipedia link
Summary:
The end of the Wikipedia link has a parenthesis, which was incorrectly used as end of markdown format for link.
Closes https://github.com/facebook/react-native/pull/9429

Differential Revision: D3722972

Pulled By: javache

fbshipit-source-id: af00f0291f00c6f2bf9bfeb7555fecd957cc6925
2016-08-16 09:58:45 -07:00
Forrest Bice 30677e7193 ReactInstanceManager API Updates
Summary:
Updating code example with updated method names...

`onHostPause` -> `onPause`
`onHostResume` -> `onResume`
`onHostDestroy` -> `onDestroy`
Closes https://github.com/facebook/react-native/pull/9217

Differential Revision: D3671267

Pulled By: javache

fbshipit-source-id: 007a2b0909fee4495a98c141bd6ac3a564b50c17
2016-08-04 13:13:33 -07:00
Tao Meng dcd7591c6e Update doc IntegrationWithExistingApps doc: Add activity theme
Summary:
Beause I found `Switch`  can't work beause the app theme set `showText` to true. It works when the theme is sett to `Theme.AppCompat.Light.NoActionBar`.
Maybe it is necessary to let users knows this and set the default theme to `Theme.AppCompat.Light.NoActionBar`.
Closes https://github.com/facebook/react-native/pull/9086

Differential Revision: D3643082

Pulled By: JoelMarcey

fbshipit-source-id: bcf6e5315753dcde6ce171018999334bcfe2c1ba
2016-07-29 14:28:41 -07:00
Gabriel METZGER 5f6237912c Update IntegrationWithExistingApps.md
Summary:
Thanks for submitting a pull request! Please provide enough information so that others can review your pull request:

> **Unless you are a React Native release maintainer and cherry-picking an *existing* commit into a current release, ensure your pull request is targeting the `master` React Native branch.**

(You can skip this if you're fixing a typo or adding an app to the Showcase.)

Explain the **motivation** for making this change. What existing problem does the pull request solve?

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

**Test plan (required)**

Demonstrate the code is solid. Example: The exact commands you ran and their output, screenshots / videos if the pull request changes UI.

Make sure tests pass on both Travis and Circle CI.

**Code formatting**

Look around. Match the style of the rest of the codebase. See also the simple [style guide](https://github.com/face
Closes https://github.com/facebook/react-native/pull/8869

Differential Revision: D3580218

Pulled By: JoelMarcey

fbshipit-source-id: 9f71825ed0a63739497ec7fa77081df0a72b6747
2016-07-18 10:13:28 -07:00
Joel Marcey b1e49832ef Make prev links work in guides and APIs.
Summary:
We had rendering support for prev links, but we never had any previous links in our metadata. Only next links. This adds that support to both Guides and APIs.

**For guides**: `previous` is manually inserted into the metadata of the actual markdown file.
**For APIs/Components**: `previous` is established via code within `extractDocs.js`

> This isn't totally perfect. For example, the transition from the last guide to the first API/component has a next link from the guide, but not a previous link from the API since the way you get the previous links are different from guides and APIs. But this gets us really close.
Closes https://github.com/facebook/react-native/pull/8754

Differential Revision: D3557972

Pulled By: hramos

fbshipit-source-id: e270bb51e7a4f59f61dad28ae0928d27d0af3d4a
2016-07-13 14:58:27 -07:00
Jon Green 6565edc9ed Fixing typo
Summary:
'iOS' was written but it should be 'Android'.
Closes https://github.com/facebook/react-native/pull/8637

Differential Revision: D3530611

Pulled By: JoelMarcey

fbshipit-source-id: 04dbb2e2188f3de73f9bc185f18950bc5de5607b
2016-07-07 14:31:04 -07:00
Kevin Lacker bfb4c054f4 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
2016-06-26 12:43:25 -07:00