Commit Graph

978 Commits

Author SHA1 Message Date
David Aurelio a710f9a81e Move packager launcher scripts outside of `packager/`
Summary: in order to prepare open sourcing React Native Packager, we have to move scripts specific to React Native to a directory that will continue to exist.

Reviewed By: javache

Differential Revision: D5112193

fbshipit-source-id: eac77d0d981aecef7ee52365a6856340420a5638
2017-05-23 16:17:09 -07:00
Hector Ramos 674a64284f Expand Getting Started, Debugging, Running on Device guides.
Summary:
- Clarified PATH instructions.
- Expand running on device instructions for iOS.
- Add Android production release instructions.
- Misc. cleanup.
Closes https://github.com/facebook/react-native/pull/14142

Differential Revision: D5116072

Pulled By: hramos

fbshipit-source-id: d95274f61a9b26282977d43d3307b726a6b93704
2017-05-23 16:03:43 -07:00
Hector Ramos 2d1c721fd6 Update Getting Started, Upgrading for CRNA
Summary:
Restored the version lag caveat in the Getting Started, and updated the Upgrading guide to account for CRNA.

Additionally, updated the release versions page to account for the new release cycle (e.g. release candidates are encouraged).
Closes https://github.com/facebook/react-native/pull/14112

Differential Revision: D5112224

Pulled By: hramos

fbshipit-source-id: d544c5178484c27f1ed6dee3479bcd94e5e81982
2017-05-23 10:31:27 -07:00
G. Kay Lee ab346dd1f9 Update Accessibility.md
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.
- [x] Match the **code formatting** of the rest of the codebase.
- [x] Target the `master` branch, NOT a "stable" branch.

Copyediting

N/A

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

Differential Revision: D5111283

Pulled By: javache

fbshipit-source-id: e352af9413c17f8f5e135590469ca65ec51d06ae
2017-05-23 04:00:36 -07:00
G. Kay Lee eee8373098 Update Colors.md
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.
- [x] Match the **code formatting** of the rest of the codebase.
- [x] Target the `master` branch, NOT a "stable" branch.

Fix broken link

N/A

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

Differential Revision: D5111260

Pulled By: javache

fbshipit-source-id: a8913b5d70e05046091a9afec18c311ac9b1ef31
2017-05-23 03:30:49 -07:00
Neo 341970d9c7 update gitignore & fix links
Summary:
fix the missing UIExplorer -> RNTester refactoring links
Closes https://github.com/facebook/react-native/pull/14104

Differential Revision: D5105736

Pulled By: hramos

fbshipit-source-id: f2a66325d08709c4967b254a1d674bf293bdd226
2017-05-22 13:03:50 -07:00
Brian Kabiro 42acab9bd2 Corrected a minor error
Summary:
Not sure if that is how it's supposed to read but tried to correct it

Thanks for submitting a PR! Please read these instructions carefully:

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

What existing problem does the pull request solve?

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 https://github.com/facebook/react-native/pull/14085

Differential Revision: D5103609

Pulled By: javache

fbshipit-source-id: 483661b149761cf6d27fb43990272312d781cc6f
2017-05-22 07:01:51 -07:00
Hector Ramos 2bf512b58c Add tabs to Getting Started and update Android Studio steps
Summary:
There are two ways to get started with React Native: using CRNA, or by building native code. The latter requires a set of dependencies that also need to be installed even by people who use CRNA if they have ejected.

There needs to be a clear demarcation between the two approaches as well as clear instructions as to which steps are of interest to CRNA using parties or people adding RN to an existing app.

Separating the two approaches entirely by using tabs can achieve this purpose.

Built and tested the website on Chrome on macOS. Have not yet tested other browsers or OS configurations.

![screencapture-localhost-8079-react-native-docs-getting-started-html-1494974542733](https://cloud.githubusercontent.com/assets/165856/26131374/77258b0c-3a4e-11e7-9a17-074610ca33d1.png)

![screencapture-localhost-8079-react-native-docs-getting-started-html-1494974580882](https://cloud.githubusercontent.com/assets/165856/26131370/73806990-3a4e-11e7-9e67-73c519b050da.png)

This is a work in progress. Feedback is appreciated. I am not yet happy with the different sets of tabs/buttons, for example.
Closes https://github.com/facebook/react-native/pull/14005

Differential Revision: D5096426

Pulled By: hramos

fbshipit-source-id: cdbf19b148ec87f2f2dfdced345084d0bbff4c26
2017-05-19 14:50:53 -07:00
Adam Perry ca2d57c744 Update examples in docs and address version lag of CRNA
Summary:
cc hramos

Pretty sure I've hit all of the places where AppRegistry is called in CRNA-pastable examples. Let me know whether you think we need to approach the version lag differently, I figure a caveat is as natural a place to call it out as any.

If you end up finding anything else that needs tweaking before cherry picking, I'm happy to push that up here too.
Closes https://github.com/facebook/react-native/pull/13744

Differential Revision: D5071038

Pulled By: hramos

fbshipit-source-id: 4a4a6f2a73079aca627f17d75a4e4b395ecbd4a8
2017-05-16 23:51:28 -07:00
Emil Ong 280ed810b0 Update docs about supported native animation props
Summary:
Thanks for submitting a PR! Please read these instructions carefully:

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

The docs had `backgroundColor` listed as a supported style prop for
native animation, but only `opacity` and `transform` are supported
at this time. See https://github.com/facebook/react-native/blob/master/Libraries/Animated/src/NativeAnimatedHelper.js#L108
My motivation was that I tried to use it and it didn't work. 😄

Github appears to render the change correctly.
Closes https://github.com/facebook/react-native/pull/13933

Differential Revision: D5071869

Pulled By: hramos

fbshipit-source-id: 947c8fa56b99d99c44603d8ef81664455234ed84
2017-05-16 13:34:48 -07:00
Fady 7785a56371 Update Example Apps Link
Summary:
The example apps link was pointing to a 404 page.

Thanks for submitting a PR! Please read these instructions carefully:

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

What existing problem does the pull request solve?
The link to example apps was pointing to a 404 page

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

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

Differential Revision: D5071821

Pulled By: hramos

fbshipit-source-id: 620902de8445fc3569c3f7b075e271b413a8544c
2017-05-16 13:16:04 -07:00
Héctor Ramos a15ec83e6c Updated Android Studio steps
Summary:
Clarified some steps unique to the Windows installer.
Closes https://github.com/facebook/react-native/pull/13983

Differential Revision: D5065884

Pulled By: hramos

fbshipit-source-id: ab47ad7e7fcf10f8b44ab209807d661c465b76a3
2017-05-16 11:31:06 -07:00
Yoichi Tagaya 7eb876e269 Fix a typo in IntegrationWithExistingApps.md.
Summary:
- [x] Explain the **motivation** for making this change.
- [x] Provide a **test plan** demonstrating that the code is solid.
- [x] (N/A) Match the **code formatting** of the rest of the codebase.
- [x] Target the `master` branch, NOT a "stable" branch.

Fixed a typo in documentation `IntegrationWithExistingApps.md`.

`"Your should see"` -> `"You should see"`

**Screenshots**

Before:

<img width="702" alt="screen shot 2017-05-10 at 12 31 53" src="https://cloud.githubusercontent.com/assets/965994/25917480/13d4bbde-357d-11e7-8977-5e5c2f43e3b9.png">

After:

<img width="699" alt="screen shot 2017-05-10 at 12 33 34" src="https://cloud.githubusercontent.com/assets/965994/25917494/1a0e4c40-357d-11e7-9ba7-8e418e2e3280.png">
Closes https://github.com/facebook/react-native/pull/13903

Differential Revision: D5044045

Pulled By: javache

fbshipit-source-id: fa4355cb26cae7de1b7fa12c3afbe9d39d7f230e
2017-05-16 02:30:31 -07:00
Dan Abramov 82fd02a1e2 Add info about inspecting instances to the docs
Summary:
Looks like this:

![](https://d2ppvlu71ri8gs.cloudfront.net/items/1N0X3d3Y2m3E3a1Z3W37/Screen%20Recording%202017-05-09%20at%2003.41%20PM.gif?v=cbf2a26b)
Closes https://github.com/facebook/react-native/pull/13866

Differential Revision: D5028363

Pulled By: gaearon

fbshipit-source-id: a07aecd31446d0361d299c2f7519a280ac2b8815
2017-05-09 12:01:49 -07:00
Eric Vicenti 8e6bde30eb Rename UIExplorer in docs
Reviewed By: ericnakagawa

Differential Revision: D5020136

fbshipit-source-id: 2aa35612c35dd4b78760215d91b6d06005033238
2017-05-08 11:31:21 -07:00
Dan Abramov 5f04678ee8 Fix Debugging doc
Summary:
My changes in https://github.com/facebook/react-native/pull/13707 assumed RN website works the same way as React website, but this assumption was wrong, so I added invalid markup.

This fixes it, and also moves the images into the website folder so we don't depend on random CDNs.
Closes https://github.com/facebook/react-native/pull/13844

Differential Revision: D5019956

Pulled By: gaearon

fbshipit-source-id: bec40d70997231a73d3ef67c82386bc1bb202d7b
2017-05-08 11:31:20 -07:00
Sandeep Ramgolam d35fef8bbb Changed registerComponent name to maintain tutorial flow.
Summary:
Changed the registerComponent name from 'HelloWolrdApp' to 'AwesomeProject' because the instructions says paste it into your index.ios.js but that doesn't actually work, unless the component is named 'AwesomeProject'.

First timers shouldn't have to deal with a big bad red screen of death. 😅
Closes https://github.com/facebook/react-native/pull/13709

Differential Revision: D5010357

Pulled By: javache

fbshipit-source-id: 101bec8e9d98fa97b3cd4a2a8e81df1f87381216
2017-05-05 12:18:04 -07:00
Dan Abramov 863e66e449 Explain how to use React Developer Tools
Summary:
Existing instructions are a bit misleading, as Chrome extension is not supposed to work, but there is still a supported way to run them.
Closes https://github.com/facebook/react-native/pull/13707

Differential Revision: D5010169

Pulled By: gaearon

fbshipit-source-id: f9558c9ccb04196854b2eef6ff40a998350b65db
2017-05-05 11:49:26 -07:00
Liron Yahdav cf5c549633 Update NativeModulesIOS.md
Summary:
Incorrectly says "seconds" while JS `getTime` returns milliseconds.

Documentation fix.

N/A
Closes https://github.com/facebook/react-native/pull/13719

Differential Revision: D4978003

Pulled By: javache

fbshipit-source-id: 6568e90b6e0650078ebc1c8652f71fb94bfe8a59
2017-05-01 06:03:20 -07:00
sunnylqm 3a86b4fcb6 add missing props
Summary: Closes https://github.com/facebook/react-native/pull/13717

Differential Revision: D4978002

Pulled By: javache

fbshipit-source-id: 685bb3bf207c858302c74de4cc711b526a80d894
2017-05-01 06:03:20 -07:00
sebasbad 8bf5cff506 Update Networking.md
Summary:
Added an example of the Fetch usage inside a component.

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 the ["Pull Requests" section of our "Contributing" guidelines](https://github.com/facebook/react-native/blob/master/CONTRIBUTING.md#pull-requests).
Closes https://github.com/facebook/react-native/pull/12348

Differential Revision: D4962419

Pulled By: hramos

fbshipit-source-id: 37b3517811f5391126d9e3ec026d2902705729a7
2017-04-28 05:56:58 -07:00
sebasbad 0f025df582 Update NativeComponentsIOS.md
Summary:
Updated map view example to correct and extend on change event management

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 the ["Pull Requests" section of our "Contributing" guidelines](https://github.com/facebook/react-native/blob/master/CONTRIBUTING.md#pull-requests).
Closes https://github.com/facebook/react-native/pull/12759

Differential Revision: D4962286

Pulled By: hramos

fbshipit-source-id: 92cc41f100616d3b5633603cf69850ebc9fc33b2
2017-04-28 05:56:58 -07:00
Hector Ramos 92bf73f689 Cleanup stale port docs
Summary:
The option to change a port is no longer displayed in the dev menu.
We don't need to call out specific apps that use port 8081.
People can now use React DevTools to debug on Chrome.
Closes https://github.com/facebook/react-native/pull/13687

Differential Revision: D4962385

Pulled By: hramos

fbshipit-source-id: ddf491e8091b5c6443ab3ca080cae5253268c6d7
2017-04-27 07:27:26 -07:00
Amal Chandran 3c355d3484 Wrong path to react native module.
Summary:
When gradle can't find RN in this path, it doesn't throw an error, but instead looks in maven and finds an old version of it (0.20.0). You can see here that's the latest version maven has: https://mvnrepository.com/artifact/com.facebook.react/react-native

I had to waste a lot of time to figure out what exactly went wrong.

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 the ["Pull Requests" section of our "Contributing" guidelines](https://github.com/facebook/react-native/blob/master/CONTRIBUTING.md#pull-requests).
Closes https://github.com/facebook/react-native/pull/12951

Differential Revision: D4962277

Pulled By: hramos

fbshipit-source-id: 5bc3d7d4ed581581f0c01c7efd450c1f9c6dbf67
2017-04-27 06:21:01 -07:00
Celine Patag 5211ce030e Update Networking.md
Summary:
The link navigators is rerouted to the getting started page.
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 the ["Pull Requests" section of our "Contributing" guidelines](https://github.com/facebook/react-native/blob/master/CONTRIBUTING.md#pull-requests).
Closes https://github.com/facebook/react-native/pull/12948

Differential Revision: D4962276

Pulled By: hramos

fbshipit-source-id: cea95163078b5ac58b468de7db4c965101de68cc
2017-04-27 06:21:01 -07:00
Hector Ramos 67a3b4c224 Remove reference to deprecated Navigator.js
Summary:
Navigator.html no longer exists. Fixes #13620.
Closes https://github.com/facebook/react-native/pull/13672

Differential Revision: D4960726

Pulled By: hramos

fbshipit-source-id: 00beb2f11ab347227e1a703b8b1f4cea2701f838
2017-04-26 19:30:57 -07:00
Emilio Srougo 515f851ab5 Suggest using babel to remove `console.*` calls
Summary:
This PR adds a suggestion to the docs to use  the `transform-remove-console` babel plugin in production to remove `console.*` calls.
This information was previously in the docs, but was [removed](e759573680) because the babel plugin [didn't work](https://github.com/facebook/react-native/issues/10412).
But now it's working well, as reported [here](https://github.com/facebook/react-native/issues/10412#issuecomment-281321709), so it would be helpful to add the suggestion again.
Ideally, this would be done automatically, as I suggested in #8337
Closes https://github.com/facebook/react-native/pull/13651

Differential Revision: D4954872

Pulled By: hramos

fbshipit-source-id: 89ae1b813c50e678f0826f16ef88c8604e13d889
2017-04-26 10:16:13 -07:00
Adam Perry 0c9b41f2c0 Include Create React Native App in Getting Started
Summary:
cc hramos

Create React Native App was designed to reduce "time to hello world" to 5-10 minutes for React Native apps. This PR would make CRNA the first way to get started that new users encounter. Included also is some text to help advanced users navigate the question of whether to use CRNA or whether to go straight to `react-native init`. It also includes a new banner for the iOS and Android guides, since they do not apply to CRNA users.

Changes are only to the website, screenshots below. This branch was created from the last CI-passing master commit this morning, dependencies were freshly installed and these screenshots are from a clean build.

[The Getting Started page](https://www.dropbox.com/s/1s7f3wu3oxr6gpo/Screenshot%202017-04-04%2015.12.29.png?dl=0)

[The "native builds only" banner](https://www.dropbox.com/s/nyv51xdiibdkn57/Screenshot%202017-04-04%2015.13.25.png?dl=0)

[Pages which still apply to CRNApps have no banner](https://www.dropbox.com/s/qgl0h6uzynqkmy2/Screenshot%202017-04-04%2015.14.10.png?dl=0)

<details>

* [x] Decide how to handle native code & react-native-cli references outside of the `banner: ejected` guides
  * [x] [Debugging: Accessing Console Logs](https://facebook.github.io/react-native/docs/debugging.html#accessing-console-logs) isn't needed in CRNA (logs are forwarded alongside packager output)
  * [x] [Debugging: With Stetho](https://facebook.github.io/react-native/docs/debugging.html#debugging-with-stetho-http-facebook-github-io-stetho-on-android) requires native code
  * [x] [Debugging: Debugging Native Code](https://facebook.github.io/react-native/docs/debugging.html#debugging-native-code) is native-only
  * [x] [AppRegistry](https://facebook.github.io/react-native/docs/appregistry.html) only applies to ejected apps, since this is generated from code, I don't think we can set `banner: ejected`?
  * [x] [Linking](https://facebook.github.io/react-native/docs/linking.html) involves changing Android manifests and other native-side things
  * [x] [PermissionsAndroid](https://facebook.github.io/react-native/docs/permissionsandroid.html) may be flaky in the Expo client, I can't recall (cc jesseruder)
  * [x] [PushNotificationIOS](https://facebook.github.io/react-native/docs/pushnotificationios.html) won't work inside Expo, as it has to [handle its own push notifs](https://docs.expo.io/versions/v15.0.0/guides/push-notifications.html)
  * [x] [Geolocation](https://facebook.github.io/react-native/docs/geolocation.html) requires a polyfill that will most likely ship with next week's release, but that won't have any manifest changes necessary
* [ ] Figure out a strategy to handle the fact that CRNA will lag stable RN releases by ~1 week
* [x] Confirm linking out to CRNA docs is an OK strategy as opposed to moving ejecting, etc. docs in-tree
* [ ] Answer questions (I'll add some review comments to call out a few things)

</details>
Closes https://github.com/facebook/react-native/pull/13303

Differential Revision: D4950661

Pulled By: hramos

fbshipit-source-id: 3dd43828f38ca6ede3f2b0683608c56420dc6525
2017-04-26 07:16:18 -07:00
Daniel Schmidt 625df661d5 Added documentation for additional fields of Image
Summary:
Hi there,

As ospfranco found there is some documentation for the code coming from #7338 missing, so I added it. It concerns the method, headers and bdoy field on the Image source object.

If you would like to have any changes made, please don't hesitate to comment, I will add them.

Have a nice day and thank you for maintaining React Native!
Closes https://github.com/facebook/react-native/pull/9304

Differential Revision: D4913262

Pulled By: javache

fbshipit-source-id: 922430ec3388560686e1cf53cb5dff7f30e4e31f
2017-04-19 05:02:12 -07:00
Himanshu Pathak 5a5fd32acb Update Colors.md, removed duplicate colors
Summary:
removed duplicate colors

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?

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 a
Closes https://github.com/facebook/react-native/pull/13555

Differential Revision: D4908510

Pulled By: javache

fbshipit-source-id: 819a3c2788232bc092cccc071f115853e7caddad
2017-04-18 13:41:22 -07:00
Vojtech Novak ea89af53cd fix typo
Summary: Closes https://github.com/facebook/react-native/pull/13418

Differential Revision: D4883386

Pulled By: javache

fbshipit-source-id: aa6195d4015ae5eb240b135a3c265be823652b11
2017-04-13 05:00:53 -07:00
sunnylqm a6df7a6ce7 fix broken link
Summary:
fix broken link
Closes https://github.com/facebook/react-native/pull/13459

Differential Revision: D4875311

Pulled By: javache

fbshipit-source-id: 73f6dc03a088237f660dcea9f3444746373d8ff9
2017-04-12 16:15:15 -07:00
Ho Chin Chee a41292d9c4 Update HAXM installation link
Summary:
Thanks for submitting a PR! Please read these instructions carefully:

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

So other Mac users wont have to dig around to look for the link.

What existing problem does the pull request solve?

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
Closes https://github.com/facebook/react-native/pull/13434

Differential Revision: D4866808

fbshipit-source-id: 9259eff382d9440754e672ad05828342091877d2
2017-04-10 23:34:04 -07:00
César Alberca a1e06dfb39 Removed extra semicolon
Summary: Closes https://github.com/facebook/react-native/pull/13389

Differential Revision: D4854128

Pulled By: hramos

fbshipit-source-id: bd7d0d12eae51fed31cf4bc2260b8c4f447e08c8
2017-04-07 18:45:30 -07:00
Ludovico Fischer 29404f087e Correct `setState()` usage in tutorial
Summary:
If the new state depends on the previous state, if I remember correctly, it’s safer to use  `setState()` with a function argument to ensure we’re not reading from an outdated `state`.

Thanks for submitting a PR! Please read these instructions carefully:

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

The tutorial suggests to use `setState()` with an object argument when the new state depends on the previous state. In such situations, it’s preferable to use a function to ensure the previous state is up-to-date.

Updates documentation only, so there are no additional tests. Rendering the site.

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 th
Closes https://github.com/facebook/react-native/pull/13358

Differential Revision: D4852404

Pulled By: hramos

fbshipit-source-id: 834759e16bcfbd5a8de71bf0c56f2b154f3321e1
2017-04-07 13:31:06 -07:00
Anurag kushwaha 01bb095c41 fix issue, closes: https://github.com/facebook/react-native/issues/13380
Summary:
Thanks for submitting a PR! Please read these instructions carefully:

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

I am just fixing typos in the docs.

proofreading

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]
Closes https://github.com/facebook/react-native/pull/13382

Differential Revision: D4851786

Pulled By: javache

fbshipit-source-id: 3cb67161653681c061d2e2b4a6a8c14527b8bd9b
2017-04-07 10:45:33 -07:00
Douglas Lowder 85d5a0e5be Apple TV documentation
Summary:
**Motivation**: Website documentation for the core Apple TV support.
Closes https://github.com/facebook/react-native/pull/13278

Differential Revision: D4839904

Pulled By: hramos

fbshipit-source-id: e8b78f3601915072c0d809b05b4b5ca61828f277
2017-04-05 19:02:48 -07:00
Brent Vatne b8542397cd Move away from rnplay to snack, with embedded examples!
Summary:
React Native Playground has been sunset, so I've replaced the examples that previously used it with examples using [Snack](http://snack.expo.io/).

The examples are directly embedded and can be edited live to see updates. The code itself is also in the docs, so we can easily update the docs in one place and we don't have to actually go to a saved app on Snack and update it there.

Run it locally, go to the `Animations` section and the `Direct Manipulation` section.

![screen shot 2017-04-03 at 6 29 51 pm](https://cloud.githubusercontent.com/assets/90494/24638271/ff3ad044-189b-11e7-845d-24b2fb612d95.png)

Open it on your phone, notice that it falls back to just showing plain code.

<img src="https://cloud.githubusercontent.com/assets/90494/24638547/203ec8fc-189e-11e7-99c8-dfabff949f8d.PNG" width="250">

- Get rid of the Expo new user experience dialog that you see when you open a Snack -- is this a dealbreaker
Closes https://github.com/facebook/react-native/pull/13285

Differential Revision: D4828011

Pulled By: hramos

fbshipit-source-id: 684ad24a14deb72abb8587ffbb726d316f126d75
2017-04-05 19:02:48 -07:00
Pieter De Baets da43c297f4 Update IntegrationWithExistingApps.md
Summary: Closes https://github.com/facebook/react-native/pull/13327

Differential Revision: D4836472

Pulled By: javache

fbshipit-source-id: 377512f8a422c40fc02a3259bccb097c38357c19
2017-04-05 12:07:38 -07:00
Robin Chou 269458c613 Update docs to clarify `RCT_REMAP_METHOD` usage.
Summary:
The current docs (iOS) for promises make use of the `RCT_REMAP_METHOD` macro but it's not clear about the proper usage for the macro. Specifically, it points to a selector of `resolver:rejector:` and makes it seem like `findEvents` is assumed as both the alias and method name.

This has led to some confusion (#9070) on how to use `RCT_REMAP_METHOD`.

No tests needed since this is just a small docs update.
Closes https://github.com/facebook/react-native/pull/13302

Differential Revision: D4831755

Pulled By: javache

fbshipit-source-id: e842c16ade27088eafdac7509373cdf7780f9ece
2017-04-05 11:00:31 -07:00
Martin Konicek 40eb353487 Minor adjustments to the mobile site
Summary:
I noticed the mobile website did not look as great, specifically the hero and the showcase had some issues.

Before:

![screen shot 2017-04-04 at 11 08 41 am](https://cloud.githubusercontent.com/assets/165856/24671655/2fb45660-1927-11e7-8ee7-bf933f459550.png)
![screen shot 2017-04-04 at 11 08 48 am](https://cloud.githubusercontent.com/assets/165856/24671656/2fb44bc0-1927-11e7-9b2e-eb944e61d778.png)

After:
![screen shot 2017-04-04 at 11 08 54 am](https://cloud.githubusercontent.com/assets/165856/24671666/36de3942-1927-11e7-81ff-eeda74d8e748.png)
![screen shot 2017-04-04 at 11 08 59 am](https://cloud.githubusercontent.com/assets/165856/24671665/36d0be70-1927-11e7-9035-382a0a09b701.png)
Closes https://github.com/facebook/react-native/pull/13298

Differential Revision: D4828679

Pulled By: hramos

fbshipit-source-id: 478ab1c5eefa5292cb2f99a9a91e18d86b3e6192
2017-04-04 12:46:43 -07:00
vivaxy 8e925d578b Update Images.md
Summary:
Remove redundant `\`` mark

Thanks for submitting a PR! Please read these instructions carefully:

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

This PR fixes Documentation typo.

No need for test.
Closes https://github.com/facebook/react-native/pull/13228

Differential Revision: D4810457

Pulled By: hramos

fbshipit-source-id: 5c475a5d8b51d4a926e0fc737e2a12805e3bf70b
2017-03-31 09:06:00 -07:00
jrodiger fd6f22253a Update GettingStarted.md (Windows Packager)
Summary:
After pull request #12755 it is no longer necessary to manually start the packager on Windows using `react-native start`. I've updated the documentation to reflect this change, and match the Mac OS - Android instructions (same commands used to launch a project now).
Closes https://github.com/facebook/react-native/pull/13186

Differential Revision: D4790827

Pulled By: hramos

fbshipit-source-id: 5fe5f7ed20ac4b3ee537c95a9b6d7b91fd578c41
2017-03-28 17:15:54 -07:00
Héctor Ramos 30778b62ea Update RunningOnDevice.md
Summary:
Taking another pass at this doc after running apps on iOS and Android devices this week. Of note, the Connecting to Dev server section on iOS seemed incomplete.

Tested steps on iOS and Android.

Tested rendering of the site on all permutations.
Closes https://github.com/facebook/react-native/pull/13143

Differential Revision: D4775026

Pulled By: hramos

fbshipit-source-id: 9b64120922a093ac646d12861d8dee98fb4e5d7d
2017-03-24 18:45:58 -07:00
Héctor Ramos 10918680eb Fix grammar in the "Running on a device" docs
Summary:
The wording had some grammar issues. The instructions were also not as precise as they could be.

Verified on Xcode 8.2.1.
Closes https://github.com/facebook/react-native/pull/13093

Differential Revision: D4763071

Pulled By: hramos

fbshipit-source-id: fe9da098f0e457efba4712db704692f6f4857624
2017-03-23 11:20:46 -07:00
Peter Hoang 123311cad2 Update GettingStarted.md
Summary:
Typing "android avd" into the terminal is not supported anymore. The android command is no longer available. There are workarounds, but it involves replacing files with the older ones.

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?

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
Closes https://github.com/facebook/react-native/pull/13096

Reviewed By: AsyncDBConnMarkedDownDBException

Differential Revision: D4762937

Pulled By: AsyncDBConnMarkedDownDBException

fbshipit-source-id: 5289402d7e6934d3493a902247a991cd1d887ec0
2017-03-23 10:45:21 -07:00
Martin Konicek e1f493ebd2 Add a flag to support a simplified iOS test - just compile, don't run packager and tests
Reviewed By: gfosco

Differential Revision: D4690887

fbshipit-source-id: e6299c9146e1ac97a0606f538e9d10539f147a67
2017-03-16 15:19:02 -07:00
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 6dab5dcd7c Link to Sketch and CRNA
Summary:
rnplay.org is shutting down on April 1st, 2017. Recommend instead using Expo's improved prototyping tool, Sketch.
Closes https://github.com/facebook/react-native/pull/12935

Differential Revision: D4709631

Pulled By: mkonicek

fbshipit-source-id: ebc020ca7973a23658dc3b63ad2ac81c2ecefe9c
2017-03-14 17:01:56 -07:00
sunnylqm 0d5620bf5e fix a typo in navigation doc
Summary: Closes https://github.com/facebook/react-native/pull/12921

Differential Revision: D4709474

Pulled By: mkonicek

fbshipit-source-id: 3c7da6ee87d350d52074a05abe168345f936858f
2017-03-14 16:46:00 -07:00
tfallon@mail.depaul.edu a0b5a6efe5 Explaining how to package ReactNative for Nexus/Maven deployment.
Summary:
**Motivation**

I needed to do this today. It's explained in code in the repository, but not included in the actual documentation. As React Native continues to grow, this is something that will be used more and more by the community.

**Test plan (required)**

No test plan required, this is simply a documentation change to add things that are only explained in code comments currently.
Closes https://github.com/facebook/react-native/pull/12938

Differential Revision: D4709339

Pulled By: mkonicek

fbshipit-source-id: a56c7573c3fa25a4059657b95b482b641ff229ff
2017-03-14 16:32:42 -07:00
Hector Ramos 30bf039d90 Documentation updates
Summary:
Tackling a handful of docs issues:

- #12780
- #11227
- #2819
Closes https://github.com/facebook/react-native/pull/12867

Differential Revision: D4691083

Pulled By: hramos

fbshipit-source-id: 9115315f2d6132e975901c9a0b784e9d41eeb49e
2017-03-10 13:05:02 -08:00
Fred Liu 28ed5eddf2 Revert D4494386: [react-native][PR] BREAKING - Remove LayoutAnimation experimental flag on Android
Differential Revision: D4494386

fbshipit-source-id: 1ba6fc60467d1c3347c90e52a3251e6591a99e25
2017-03-09 20:16:37 -08:00
iboxgithub b79a24637a Update Troubleshooting.md
Summary:
Following ericvicenti request on https://github.com/facebook/react-native/issues/10188#issuecomment-282448021
Hope it helps

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
Closes https://github.com/facebook/react-native/pull/12578

Differential Revision: D4682076

Pulled By: mkonicek

fbshipit-source-id: 2fab5355a066eb3d8333e50f07ab3a258cbc002b
2017-03-09 09:32:02 -08:00
Dan Abramov a94d14c47c Make a section on keyboard shortcuts more prominent
Summary:
The note is currently in "Reloading JavaScript". However I was struggling with the first step ("Accessing the In-App Developer Menu") so didn't read down to that section.

I think it makes sense to make this the very first thing the reader sees when visiting the page.
Closes https://github.com/facebook/react-native/pull/12828

Differential Revision: D4681842

Pulled By: hramos

fbshipit-source-id: 1afbec7f62a2ec97febdd05987e7fc1541d3ee28
2017-03-09 08:15:45 -08:00
Héctor Ramos 3672b20a05 Recommend installing latest version of Xcode
Summary:
Xcode 8 is required as of 453e70d19c
Closes https://github.com/facebook/react-native/pull/12810

Differential Revision: D4677067

Pulled By: hramos

fbshipit-source-id: 6de932fe8a79b13f0bb13aba10baf2d1960f8a4f
2017-03-08 16:05:50 -08:00
James Ide f637936f77 Some more Exponent -> Expo updates
Summary:
Updates the remaining references to Exponent to Expo, similar in spirit to b698b4ad62. Left the filename of the blog post alone so that permalinks keep working.
Closes https://github.com/facebook/react-native/pull/12776

Differential Revision: D4676911

Pulled By: hramos

fbshipit-source-id: 5b8b8413f95c984df4157e4e1634dd35a78afa29
2017-03-08 15:47:40 -08:00
Janic Duplessis abc483a653 BREAKING - Remove LayoutAnimation experimental flag on Android
Summary:
I don't remember exactly where we talked about this but LayoutAnimation on Android is pretty stable now so there's no reason to keep it behind an experimental flag anymore. The only part that is not really stable is delete animations, so what I did is remove the default delete animation that we provide in presets.

**Test plan**
Tested that layout animations work properly without any config.
Closes https://github.com/facebook/react-native/pull/12141

Differential Revision: D4494386

Pulled By: mkonicek

fbshipit-source-id: 5dd025584e35f9bff25dc299cc9ca5c5bf5f17a3
2017-03-08 06:45:22 -08:00
Hector Ramos 3f6476fc5e Tweak presentation of Colors guide.
Summary:
Explain a bit more how these are used.
Closes https://github.com/facebook/react-native/pull/12753

Differential Revision: D4663972

Pulled By: hramos

fbshipit-source-id: acbda6593e3f2a01776d2208f6ef3bc69bca0eef
2017-03-06 18:01:06 -08: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
Michael Jackson c535c263c6 Remove reference to react-router-native
Summary:
We're currently taking ownership of react-router-native and have shipped several beta releases that do not wrap the NavigationExperimental API. In order to avoid confusion, I'd appreciate it if we could avoid mentioning react-router-native here. Thanks :)
Closes https://github.com/facebook/react-native/pull/12691

Differential Revision: D4654551

Pulled By: hramos

fbshipit-source-id: d1f393cefc87f087d4e9c19b7cbee861f0a2d29a
2017-03-05 23:00:28 -08:00
Jonathan Sagorin caa9d848d6 Update State.md
Summary:
Changes to setState will cause re-renders.
**Test plan (required)**
Textual changes only - on Markdown only

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 the ["Pull Requests" section of our "Contributing" guidelines](https://github.com/facebook/react-native/blob/master/CONTRIBUTING.md#pull-requests).
Closes https://github.com/facebook/react-native/pull/12647

Differential Revision: D4658053

Pulled By: ericvicenti

fbshipit-source-id: 0d9cde8f9710b4e0f7d7f82214d8eeda0bf3c135
2017-03-05 22:48:04 -08:00
Esa Juhana Lahikainen cdcd620480 Improve iOS' running on device instructions
Summary:
Add missing step needed to run your project on a device

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
Closes https://github.com/facebook/react-native/pull/12718

Differential Revision: D4657289

Pulled By: ericvicenti

fbshipit-source-id: f73736027d3872c63046c8a46307e9b486b4d444
2017-03-05 11:46:46 -08:00
Sung Won Cho 7e2d7f0c98 Replace the outdated flag
Summary:
**Motivation**

Documentation was referring to an outdated command line flag for building a signed APK. https://github.com/facebook/react-native/issues/12698

**Test plan**

This PR does not contain any code changes.
Closes https://github.com/facebook/react-native/pull/12699

Differential Revision: D4655915

fbshipit-source-id: fdad86e0be60929525172022980f1950c8b0188d
2017-03-04 00:16:29 -08:00
Jack Stevens 8174a0dc08 Remove semi-colons after class definition
Summary:
None of the preceding code examples have semi-colons after the class definition (because they're not necessary):

- https://facebook.github.io/react-native/docs/tutorial.html
- https://facebook.github.io/react-native/docs/props.html
- https://facebook.github.io/react-native/docs/state.html
- https://facebook.github.io/react-native/docs/style.html

For consistency, I removed them 👍
Closes https://github.com/facebook/react-native/pull/12616

Differential Revision: D4651704

fbshipit-source-id: e59fa37c82d61728bc8ee28c7109717bd10635c2
2017-03-03 12:30:25 -08:00
Hector Ramos cf4891c6bd Update Getting Started instructions.
Summary:
I am starting fresh on a new Mac and took another stab at the instructions.

- Java SDK 7 seems to work just fine.
- Adjusted Custom Android Studio installation instructions to use bare minimum required.
- Updated AVD configuration instructions with necessary changes to run AVD the first time.
- Added note on using real devices.
- Removed notes warning against use of API Level 23, these do not belong on a Getting Started guide.
- Added step to install Xcode Command Line Tools.
- Use `.profile` over `.bashrc` as the latter is shell-specific and is not loaded on login shells (e.g. new Terminal windows). `.profile` will work on bash, however, which is the default macOS shell.
- Added screenshots.

Went through steps for setting up RN for iOS as well as Android on a new Mac. Ended with apps running on the iOS Simulator and a AVD.

Generated website and verified instructions rendered correctly for each of the OS/device permutations.
Closes https://github.com/facebook/react-native/pull/12272

Differential Revision: D4637737

Pulled By: hramos

fbshipit-source-id: 5d322e4d55dbabc70f70471622a2f379ac6230cb
2017-03-01 19:26:28 -08:00
Eric Vicenti 08dbc43fa6 Deprecate NavigationExperimental
Summary:
Docs change to encourage people to use React Navigation over other options.

Explains a bit of history about Navigator and NavigationExperimental.

Remove an intro guide that encourages use of Navigator. Hopefully the existing ReactNav guide fills this void.

Navigator docs are less emphasized but still present.

Reviewed By: mkonicek

Differential Revision: D4634452

fbshipit-source-id: 26763c2f02530009b3dfd20b0590fadcb5ea35ee
2017-03-01 11:50:03 -08:00
Daniel Fischer 0097ab98a7 Update UsingAScrollView.md
Summary:
Simple spacing update for consistency.

Super simple PR. I'm just fixing the spacing in the documentation to be consistent with the other docs.
Closes https://github.com/facebook/react-native/pull/12549

Differential Revision: D4608409

Pulled By: hramos

fbshipit-source-id: 9df0e3e0260d292e6788f32a713552c30240da47
2017-02-28 06:23:58 -08:00
Valentin Shergin b00c1fa3b6 `accessibilityViewIsModal` property was exposed for any view (iOS only)
Reviewed By: mmmulani

Differential Revision: D4582786

fbshipit-source-id: 0902b8cc762042e772798ea7eaa350bc9d737cfb
2017-02-27 23:46:14 -08:00
Adam Comella 04790f1a78 Finish AccessibilityInfo implementation
Summary:
This PR is based on files ericvicenti gave me. Specifically, he gave me:
  - AccessibilityInfo.android.js
  - AccessibilityInfo.ios.js
  - AccessibilityInfoModule.java

Before this change, only a native iOS implementation of AccessibilityInfo existed. This change includes:
  - A native Android implementation of AccessibilityInfo.
  - JavaScript wrappers for the AccessibilityInfo module for both iOS and Android.
  - UIExplorer changes to illustrate how to use AccessibilityInfo on iOS and Android.
  - Documentation for the AccessibilityInfo APIs.

**Test plan (required)**

Tested the UIExplorer AccessibilityInfo example on iOS and Android with the screen reader both enabled and disabled.

Adam Comella
Microsoft Corp.
Closes https://github.com/facebook/react-native/pull/12273

Reviewed By: mkonicek

Differential Revision: D4527224

Pulled By: ericvicenti

fbshipit-source-id: d04638465ccbdbb35ecfc9504daaeb8e33aab57a
2017-02-27 18:34:19 -08:00
Javier Olaechea 2d44908afa Don't use 'vertically' when describing a ListView
Summary:
it gives the wrong impression that a ListView has the restriction to only align the items vertically

The problem the PR addresses is that the documentation currently gives the initial impression that a ListView can only stack the items vertically.
Closes https://github.com/facebook/react-native/pull/12564

Differential Revision: D4622096

Pulled By: hramos

fbshipit-source-id: ce634087d143a28904d998a4c7301ca18392714e
2017-02-27 14:04:58 -08:00
Valentin Shergin 4ba983401f Usage `intrinsicContentSize` property of `RCTRootView` intead of deprecated `intrinsicSize`
Reviewed By: blairvanderhoof

Differential Revision: D4589913

fbshipit-source-id: 6d966e9b90a0cf3e736ac20e2b6f35cbf92ff3f3
2017-02-27 14:04:58 -08:00
Héctor Ramos fab09922cd fix duplicate symbols error in the Creating Native UI Component docs
Summary:
When creating Native UI Component per docs, it results in duplicate symbols error as explained in issue #12404

Instead of using RCT prefix, it is suggested to use RN prefix to avoid any duplicate symbols.
Closes https://github.com/facebook/react-native/pull/12523

Differential Revision: D4608532

Pulled By: hramos

fbshipit-source-id: 353cfee4bf2cea30706863af51cabe11e9394222
2017-02-23 16:45:39 -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
Ryan Florence c6d56d944c remove more peculiar web language
Summary:
I guess we could ask Håkon Wium Lie if indeed it was unintended to have a set of rules be inherited or not, but this paragraph is a little bit weird 🤷‍♀️
Closes https://github.com/facebook/react-native/pull/12485

Differential Revision: D4608425

Pulled By: hramos

fbshipit-source-id: a346b1e65c9fc7b06634e529c1ef6f9e24794cca
2017-02-23 16:31:41 -08:00
Mike Griepentrog 7aa9f21dac Fix broken link
Summary:
> Explain the **motivation** for making this change. What existing problem does the pull request solve?

I was reading the documentation and noticed this broken link.
Closes https://github.com/facebook/react-native/pull/12535

Differential Revision: D4608413

Pulled By: hramos

fbshipit-source-id: 5d3edfaf4e5c16f42a50e203b979b90afe101954
2017-02-23 16:31:40 -08:00
Andrew Rasmussen bf5aa9e1e7 Product Pains -> Canny
Summary:
We migrated everyone on Product Pains over to our new service, Canny. We also moved every product's feedback to a product-specific subdomain (eg. https://react-native.canny.io/feature-requests).

This PR updates every Product Pains URL over to its new Canny version.

Changes only affect docs, blog posts, and bot responses - not the React Native library itself.

**Test plan**

I visited https://react-native.canny.io/feature-requests. Since there are no code changes this seems sufficient but let me know if I need to run the blog website or something.
Closes https://github.com/facebook/react-native/pull/12429

Differential Revision: D4581492

Pulled By: hramos

fbshipit-source-id: 7d124ab7ed9228d47f1bc4417d8992f15ff17f01
2017-02-17 15:02:23 -08:00
Hector Ramos 6ad41a81bc Clean up Animated docs
Summary:
After taking a look at the existing animation docs, I found that most of the documentation on using `Animated` was spread out throughout the Animations guide and the `Animated` API reference, without any particular structure in place.

This PR aims to clean up the API reference, focusing on documenting all the provided methods exhaustively, and deferring to the Animations guide for long form examples and supporting content.

The `Easing` module is referred to at various points in the API reference, so I decided to clean up this doc as well. easings.net provides some handy visualizations that should make it easier for the reader to understand what sort of easing curve each method provides.

The site was built locally, and I verified all three documents render correctly.

![screencapture-localhost-8079-react-native-docs-animations-html-1487212173651](https://cloud.githubusercontent.com/assets/165856/23004694/d3db1670-f3ac-11e6-9d4e-0dd6079b7c5c.png)

Closes https://github.com/facebook/react-native/pull/12410

Differential Revision: D4581314

Pulled By: hramos

fbshipit-source-id: 27c0bce2afac8f084311b9d6113a2641133b42e5
2017-02-17 14:48:17 -08:00
Jeremy Kun c728915944 Update grammar and typos in documentation
Summary:
I was reading the documentation and noticed a few typos and grammar mistakes.

- rely -> relies
- Adding 'a' and 'its' and 'the' where appropriate
- Minor simplifications
Closes https://github.com/facebook/react-native/pull/12385

Differential Revision: D4570713

Pulled By: hramos

fbshipit-source-id: dbf0506306fd16b3454a2ec96792bda2c7bcaa70
2017-02-15 20:16:10 -08:00
Dan Abramov 3135a639e6 Update "Getting Started" to match latest Android Studio
Summary:
The "Configure" menu includes a dropdown:

<img width="221" alt="screen shot 2017-02-13 at 20 43 57" src="https://cloud.githubusercontent.com/assets/810438/22902608/8bb2ddf4-f22d-11e6-9d02-da498e06dfed.png">

I also clarified the UI role of labels (a tab and a checkbox) because I didn't notice them at first.
Closes https://github.com/facebook/react-native/pull/12365

Differential Revision: D4570633

Pulled By: hramos

fbshipit-source-id: 00fdf8fb9f933a37de76deed6dedfb8dfa4f15a0
2017-02-15 20:00:42 -08:00
Kevin Lacker a023d0d057 remove inaccurate docs
Summary:
Our docs suggest using this babel plugin to remove console.log statements in production. Unfortunately, it does not actually work when you run it on a new React Native project, and the root cause is that the plugin does not handle all cases correctly. See discussion in https://github.com/facebook/react-native/issues/10412 . For now, we should just stop recommending that people use this plugin, because it doesn't work.
Closes https://github.com/facebook/react-native/pull/12315

Differential Revision: D4538567

Pulled By: hramos

fbshipit-source-id: f3ae1b9143130a05601907ee902a02fc0b2818b0
2017-02-09 13:32:31 -08:00
Andrew Rabon 787e2730aa Fix ADB reverse link + release build instructions
Summary:
ADB reverse link was broken, and the "release build" instructions did not work (--configuration doesn't exist.)
Closes https://github.com/facebook/react-native/pull/12312

Differential Revision: D4538302

Pulled By: hramos

fbshipit-source-id: 6d2e7ee07f9fad6080ed79bc8e0e4db11e6bbed3
2017-02-09 13:01:37 -08:00
Jonas Helfer e8ba333e0a Tiny grammar fix
Summary:
> Explain the **motivation** for making this change. What existing problem does the pull request solve?

Comments with correct grammar are easier to read.
Closes https://github.com/facebook/react-native/pull/12313

Differential Revision: D4538229

Pulled By: hramos

fbshipit-source-id: 69978df3659f2d3e4f5b2ccb4ff6c33dc6b7e56b
2017-02-09 12:47:04 -08:00
Kevin Lacker f43d0a9678 Clearer information regarding RCT_EXPORT_MODULE
Summary:
I think this update is Critical as I wanted to add a different module name to be the same as the Android module name. I simply lost 6 hours until I found out that the Macro does not accept String syntax. Almost drove me crazy. Please, at least do something about it. Thanks.

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
Closes https://github.com/facebook/react-native/pull/11634

Differential Revision: D4533312

Pulled By: lacker

fbshipit-source-id: 2c547f791ed76ba62e0c7e5cabc2830dbae34075
2017-02-08 16:46:13 -08:00
Kevin Lacker edd957007d Docs: add warining about possible memory leaks while using native mod…
Summary:
Currently callbacks passed to native method are stored in [MessageQueue](https://github.com/facebook/react-native/blob/master/Libraries/BatchedBridge/MessageQueue.js#L160-L162) and [will be removed after invocation](https://github.com/facebook/react-native/blob/master/Libraries/BatchedBridge/MessageQueue.js#L273-L274), so to avoid memory leak in js-side the passed callback(s) must be invoked by native method.

Because of this significant nuance of callbacks usage, which is not (or not directly) mentioned  in docs, we have gained huge increase of ooms count in our app. So, I think this warning will help other developers to avoid this issue
Closes https://github.com/facebook/react-native/pull/11444

Differential Revision: D4532764

Pulled By: lacker

fbshipit-source-id: 34e99fa4944c3333b2198c1abd53c0da10732749
2017-02-08 16:00:12 -08:00
moses gunesch 28ea2d6261 Add static non-image assets section
Summary:
Support for non-image assets like audio and video was added a while back
Closes https://github.com/facebook/react-native/pull/12053

Differential Revision: D4489209

Pulled By: mkonicek

fbshipit-source-id: 4e2bdf7ef07bcc8c563c055ed0a4fe5cc51bd0bc
2017-01-31 13:28:32 -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
fcFn 7ed529bf2f Fix typo in GestureResponderSystem.md
Summary:
There is only `timestamp `property in touch native event, `event.nativeEvent.timeStamp` is undefined.
Closes https://github.com/facebook/react-native/pull/11988

Differential Revision: D4489408

Pulled By: mkonicek

fbshipit-source-id: 0148a4107124438f345b8cb584e1832ba51b3a4b
2017-01-31 11:58:30 -08:00
Jones Melton ad97adb3c7 Correct minor phrasing error for clarity
Summary:
A simple correction of what looks like a copy-paste error in the writeup of NavigationExperimental.
Closes https://github.com/facebook/react-native/pull/12081

Differential Revision: D4482725

Pulled By: mkonicek

fbshipit-source-id: 8c7c6ad19ed96e3287b4d0ef809685b5201b4fc0
2017-01-30 11:13:41 -08:00
David Brownman 7cebe26681 use https for bash links
Summary:
Never a good idea to pipe a bash file from `http` into `sudo`. Using `https` mitigates some of this risk.
Closes https://github.com/facebook/react-native/pull/12090

Differential Revision: D4474065

fbshipit-source-id: 99d29ae112ae0edef5bd662d439b5da673c5c79f
2017-01-26 23:43:47 -08:00
kvg452@sina.com 5bb19a5bf5 Add 'Android SDK Platform 23' to check list
Summary:
Add 'Android SDK Platform 23' to the check list when install the proper Android SDK.

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.c
Closes https://github.com/facebook/react-native/pull/11744

Differential Revision: D4464520

Pulled By: hramos

fbshipit-source-id: 2cfabdadc8a94f35cbbd37d9dce46375e8b954c3
2017-01-25 14:28:28 -08:00
Seong-hyun, Oh 4ff659345c Update NativeComponentsIOS.md
Summary:
Only NativeComponentsIOS.md documentation changed.

Closes https://github.com/facebook/react-native/pull/12012

Differential Revision: D4452008

Pulled By: ericvicenti

fbshipit-source-id: 9ee748165a4efc9f987c5cadff8a21ab17f971c6
2017-01-23 14:43:28 -08:00
C. T. Lin 29a996c83e variant -> configuration
Summary: Closes https://github.com/facebook/react-native/pull/11909

Differential Revision: D4432605

Pulled By: hramos

fbshipit-source-id: 760d043da383aa14a331d8420f6f28647edb046c
2017-01-23 11:28:51 -08:00
Louis Lagrange fa21822241 Fix some typos in NativeModulesAndroid.md
Summary:
Hi, here are some typo fixes in the documentation related to Android native modules:
* Add missing package and imports for the second part of the basic tutorial (register module)
* Add missing `public` keyword
* Remove incongruous word
Closes https://github.com/facebook/react-native/pull/11938

Differential Revision: D4439220

Pulled By: hramos

fbshipit-source-id: e7086fe384ed6238306abf0ee72c944fac53ad7b
2017-01-19 17:13:28 -08:00
AgtLucas dd8231ad63 Fix Android debugging doc
Summary:
I've tried to debug my Android app using Stetho as is documented [here](https://facebook.github.io/react-native/docs/debugging.html#debugging-with-stetho-http-facebook-github-io-stetho-on-android), but, it turns out the documentation is wrong, because if we pass `Bundle savedInstanceState` to `onCreate` method, the app crashes itself, so I've updated the documentation accordingly.
Closes https://github.com/facebook/react-native/pull/11796

Differential Revision: D4437893

Pulled By: hramos

fbshipit-source-id: fbb026e4480ae08128404ed2cf4ddb00a35f7d7b
2017-01-19 14:13:30 -08:00
Mehdi Mulani 81c33b542d Switch out DISABLE_YELLOW_BOX for IS_TESTING
Summary: Switch to using IS_TESTING on the Platform module. While IS_TESTING has to be explicitly set in the test harness, this makes it more usable and stops people from relying on brittle variables in the (larger) environment.

Reviewed By: fkgozali

Differential Revision: D4423661

fbshipit-source-id: 27a80867778b9374bcba67b69f9c93d32c0a74b0
2017-01-18 12:28:42 -08:00
Peter Salanki 52d8851fc8 Cache policy control for image source
Summary:
In the context of an app an image exists in three resolutions on the server: `thumb` (30px) `feed` (300px) `full` (900px). When looking at an individual item a user can come either from the feed, via a permalink or from other parts of the app. This allows a situation where the `feed` image might or might not already be loaded somewhere in the app. In the detail view I want to render `thumb` with a blur (to quickly display something), then the `feed` image if it exists to have something decent to display until `full` loads. However it is quite a waste to load the `feed` image if it isn't already in cache, and will slow down the time until `full` is loaded. It is possible to track the navigation from feed->detail and that the `feed` image has actually completed loading by the feed component however as component hierarchies grow this turns into quite a lot of prop passing and bad separation of concerns.

NSURLRequests accepts a [Cache Policy](https://developer.apple.com/reference/fo
Closes https://github.com/facebook/react-native/pull/10844

Differential Revision: D4425959

Pulled By: lacker

fbshipit-source-id: 679835439c761a2fc894f56eb6d744c036cf0b49
2017-01-17 17:13:31 -08:00
janus_wel bc432ae324 fix typo RTC to RCT
Summary:
Explain the **motivation** for making this change. What existing problem does the pull request solve?

Descriptions about class names are incorrect.
Closes https://github.com/facebook/react-native/pull/11898

Differential Revision: D4418957

fbshipit-source-id: fc7d0b61149ed9f850a436a35ad98f179b5e3e19
2017-01-13 18:58:23 -08:00
Mehdi Mulani 49d7c00500 Disable yellow box warnings based on environment variable
Summary:
This adds a hook to let you disable yellow box warnings. It's useful for native engineers who don't want to mess with JS but also for CI/testing, where the app operates mostly as a blackbox.

Depends on D4395091

Reviewed By: achen1

Differential Revision: D4395552

fbshipit-source-id: 4c3a9676caa975c537d1a4711d60aab2f404db15
2017-01-13 12:28:31 -08:00
sunnylqm d0116d52bd typo (data -> intent)
Summary: Closes https://github.com/facebook/react-native/pull/11856

Differential Revision: D4409174

Pulled By: foghina

fbshipit-source-id: 9b3f75d5f0515294e3b48dc3d9284b0cf684d152
2017-01-12 10:13:33 -08:00