Commit Graph

292 Commits

Author SHA1 Message Date
Meredith Leu f502e17cc7 Fix broken links 2015-07-27 18:34:12 -07:00
Martin Konicek 01911e5e06 [docs] Make it clear which Guides are platform-specific
This is in preparation for open sourcing React Native for Android.
Also add hyphens to URLs for consistency. This can break people's
browser bookmarks but it's better to be consistent and we can
redirect to docs: https://github.com/facebook/react-native/issues/2137

Test plan: Ran the website locally using `cd website; npm start`
and checked all pages render correctly.
http://i.imgur.com/RrPNgRr.png

Will update "Getting Started", "Tutorial", "Debugging" and
"Testing" separately.
2015-07-27 18:17:54 +01:00
Tj 1e5f22dc9c Updating for Code Review
Using UIStatusBarAnimation for real world example
2015-07-21 18:11:58 -04:00
Tj 4d3c3e625e Enum Constants Explanation
Explains the use of `RCT_ENUM_CONVERTER` for using `NS_ENUM` arguments in exported functions
2015-07-21 16:46:40 -04:00
Mark Miyashita f3dd07531c [Docs] Animated example for onScroll and onPanResponderMove should match the description in the paragraph above 2015-07-19 17:05:25 -07:00
Sam Mueller f732e46581 Clarify docs to use animated over react-tween-state & rebound 2015-07-10 14:04:45 -07:00
Khoa Phan 572157d14b Minor grammatical fixes:
1. 'Install' should be 'installed' (past tense)
2. Change 'checkout' to 'check out'
2015-07-09 19:48:25 -07:00
Spencer Ahrens bda7f7389a Add new Animated API to animation docs. 2015-07-09 14:47:47 +02:00
Spencer Ahrens 57513fd24a make `npm test` command easier to find 2015-07-08 14:03:05 +02:00
Spencer Ahrens 2829be7de6 Note about setting up jest environment (io.js etc) 2015-07-08 14:01:28 +02:00
Brent Vatne 90022023c9 Merge pull request #1802 from ide/iojs-docs
[Docs] Update installation docs to reference io.js instead of Node
2015-07-07 16:35:25 -07:00
Colin Ramsay b13e2e8c2e Update NativeModule documentation to show correct event emitter usage
It looks like in the various changes to native module events, the documentation has become a little confused. As far as I can tell, if you use `sendAppEventWithName` then the `NativeAppEventEmitter` is used and if `sendDeviceEventWithName` then it should be `DeviceEventEmitter`.
2015-07-07 15:04:50 +01:00
James Ide a97a866570 [Docs] Update installation docs to reference io.js instead of Node
It's pretty straightforward -- io.js is available through Homebrew so all you run is `brew install iojs` and then you can still run `node` from the command line. Also mentioned nvm since it's really good for switching between Node/io.js versions.
2015-07-02 11:42:25 -07:00
James Ide eee630827a Merge pull request #1818 from facebook/amasad-patch-1
Don't encourage the use of internal modules
2015-06-30 13:13:50 -07:00
Amjad Masad 82ca3364c6 Don't encourage the use of internal modules 2015-06-30 13:12:47 -07:00
Amjad Masad e5ba0f388b Don't encourage the use of internal modules 2015-06-30 13:12:00 -07:00
Dan Horrigan cae410bda0 [Docs] Update TimerMixin docs.
Adds in install instructions for `react-timer-mixin` to the `TimerMixin` docs.
2015-06-30 13:23:40 -04:00
Alexsander Akers 36cda5619a Remove duplicate Accessibility header 2015-06-25 13:25:46 -04:00
Alexsander Akers 948fe5b127 Merge pull request #1726 from a2/accessibility-docs
Add docs page for accessibility support
2015-06-25 11:16:59 -04:00
Alexsander Akers d01dc1d47e Note that magic tap traverses up the view hierarchy 2015-06-25 11:02:34 -04:00
laiso 53756a712c [Docs] Xcode has a lower-case c
a similar commit: aa7e318a3f
2015-06-24 12:18:09 +09:00
Alexsander Akers 4879d141a0 Code review from @brentvatne 2015-06-23 17:26:46 -04:00
Alexsander Akers b28766670d Fix "id" field 2015-06-23 15:47:26 -04:00
Alexsander Akers 5921f5f702 Add docs page for accessibility support 2015-06-23 15:15:18 -04:00
Param Aggarwal a9415370cb Better clarify the 'Header Search Paths' section 2015-06-23 07:57:38 +05:30
Param Aggarwal f03d6df277 Add an 'Xcode Build Failures' section 2015-06-22 11:14:35 +05:30
Brent Vatne e1d5cadf44 [Docs] Add Animations guide 2015-06-20 09:17:36 -07:00
Brent Vatne aac8172815 [Docs] Fix typos in DirectManipulation.md 2015-06-18 09:27:46 -07:00
Brent Vatne 0881b0f99f Merge pull request #1656 from brentvatne/set-native-props-docs
[Docs] Add DirectManipluation guide to explain setNativeProps
2015-06-17 21:47:50 -07:00
Brent Vatne e2c6060226 [Docs] Add DirectManipluation guide, which explains setNativeProps 2015-06-17 21:43:39 -07:00
Brent Vatne 7733c777bf Merge pull request #1663 from brentvatne/navigator-vs-navigator-ios
[Docs] First draft of Navigator vs NavigatorIOS docs
2015-06-17 18:32:49 -07:00
Brent Vatne eab118401e [Docs] Add Navigator Comparison section to Guides 2015-06-17 18:32:26 -07:00
Spencer Ahrens 529803e5c4 Update Testing.md
- Include explanation for updating snapshot tests.
- Fix links after code motion
- Other cleanup.
2015-06-16 10:22:49 -07:00
Brent Vatne 9dc9648504 [Docs] Fix missing parameter in NativeModules addEvent date example 2015-06-13 12:05:23 -07:00
Kevin deLeon 40b1976233 Fixes spelling error in requested change. 2015-06-07 16:42:06 -05:00
Kevin deLeon b39aed4d0a Adds additional info for creating Swift modules
This may be common knowledge for most Swift/ObjC guys, but it took me quite a while to figure out why I was getting an error when creating/exporting my module. As a web guy coming to the "native" world, it was a bit confusing. I would imagine a lot of RCTN users will be in the same boat.
2015-06-07 16:31:40 -05:00
Christopher Chedeau b63a0a111d Update JavaScriptEnvironment.md
`for of` is not enabled
2015-06-03 09:57:13 -07:00
Jehan c4457f8e6f Update NativeComponentsIOS.md 2015-06-03 00:34:25 -07:00
Brent Vatne aa7e318a3f [Docs] Xcode has a lower-case c 2015-06-02 14:06:30 -07:00
Brent Vatne 613e561751 [Docs] Update Getting Started to include recommended XCode version 2015-06-02 14:04:49 -07:00
Brent Vatne c700f71cb5 [Docs] Add link to Homebrew in tutorial, suggestion for node install 2015-06-01 12:42:49 -07:00
Brent Vatne 53a7e070b8 Merge branch 'babel-documentation' 2015-05-31 10:08:16 -07:00
Brent Vatne d6ac633de5 [Docs] Tweak wording of JavaScriptEnvironment docs 2015-05-31 10:07:42 -07:00
James Ide 69ce448de9 Merge pull request #1457 from christopherdro/timer-doc-fix
[Docs] Grammatical change / Timer
2015-05-30 18:22:05 -07:00
Christopher Dro 597f9d94fd Changes based on @brentvatne revision 2015-05-30 18:00:34 -07:00
Brent Vatne e65eff8df6 [Docs] Add supported iOS version to getting started 2015-05-30 15:09:32 -07:00
Christopher Dro 47e56d778a Re-wording 2015-05-30 14:47:24 -07:00
Brent Vatne 39b2342ab9 [Docs] Add note about Chrome extensions interacting with debugger 2015-05-30 13:24:53 -07:00
Christopher Dro 5918be2325 Typo Fix
Oddly enough, adding `work` was the first change I wanted to do. :)
2015-05-30 00:46:30 -07:00
Christopher 2429324e79 [Docs] Gramatical change / Timer 2015-05-30 00:14:22 -07:00
Joshua Sierles f9b3f9121f update JS environment documentation for Babel, and explain what a transpiler does. 2015-05-29 22:50:03 +02:00
Brent Vatne 1a4f270931 Merge branch 'debugging-docs' 2015-05-29 13:04:54 -07:00
Brent Vatne ee8ba19ab1 [Docs] Tweak debugging docs to be more concise 2015-05-29 13:04:25 -07:00
Flip Stewart 1a3ee99365 [Docs] Clean up debugging docs 2015-05-29 13:03:33 -07:00
Brent Vatne 731335eb7c [Docs] Add DeviceEventEmitter require to NativeModulesIOS docs 2015-05-27 09:43:44 -07:00
James Ide 64ae42c10a Merge pull request #1395 from pwmckenna/touchableopacitysinglechilddocs
Add doc warning stating that TouchableOpacity can only support a single child
2015-05-25 22:20:19 -07:00
Patrick Williams 0466bbd616 Add doc warning stating that TouchableOpacity can only support a single child 2015-05-25 22:03:43 -07:00
Brent Vatne 1586f3114c [Docs] Add note about build being required for any change to Images.xcassets 2015-05-25 12:57:54 -07:00
Brent Vatne c2aa16607f [Docs] Clarify image docs for the current state of asset packaging 2015-05-25 12:24:50 -07:00
Brent Vatne ffcdf21004 [Docs] Clarify the variables provided to RCT_CUSTOM_VIEW_PROPERTY body 2015-05-24 09:35:59 -07:00
Brent Vatne 424d1318c8 [Docs] Linking Libraries fix site->side, prefer only to just 2015-05-17 18:41:40 -07:00
James Ide 69db752067 Move requireNativeComponent call below the complete MapView definition
requireNativeComponent should be called after the wrapper component is fully defined, including its static properties.
2015-05-13 21:05:50 -07:00
Zhao Han 85a6734387 Update link in Native UI Components (iOS) guide
Update the event mapping link: update line number
2015-05-13 10:08:38 -05:00
Brent Vatne e0adedde78 Merge pull request #764 from Rudimental/patch-1
Fix grammar in EmbeddedApp.md
2015-05-11 14:02:51 -07:00
Brent Vatne 4bec3fe665 Merge pull request #1193 from itsananderson/patch-1
Fix typo in LinkingLibraries.md
2015-05-07 18:29:50 -07:00
Brent Vatne debd5b0942 [Docs] Remove Transforms from sidebar, add to Style 2015-05-07 16:05:30 -07:00
Will Anderson d3119a8fb1 Fix typo in LinkingLibraries.md
s/insed/inside
2015-05-07 15:05:28 -07:00
Quico Moya c88b1d2c88 Fix grammatical error 2015-05-06 12:29:25 +02:00
James Ide 0e3d627ff0 Fix some typos in NativeComponentsIOS.md
Fixed some syntax errors and tidied up the sample code.
2015-04-30 00:39:37 -07:00
Spencer Ahrens f89bcacd86 Add missing 'and' in docs. 2015-04-29 15:42:30 -07:00
Spencer Ahrens 8efe148f07 Fix bullet spacing for website.
GitHub markdown rendered it fine, but it was all mashed inline on the website without the extra break.
2015-04-29 15:41:17 -07:00
Brent Vatne d662a307b7 [Docs] Fix missing : in Swift NativeModules doc 2015-04-27 23:32:11 -07:00
Brent Vatne bfdd1d6443 Merge pull request #1021 from robertjpayne/master
Documentation for exporting Swift Native Modules
2015-04-27 23:24:04 -07:00
Nick Lockwood 89495635da Update NativeModulesIOS.md 2015-04-26 19:44:55 +01:00
Robert Payne 8c8b28969e Documentation for exporting Swift Native Modules 2015-04-26 18:06:43 +12:00
Spencer Ahrens 644d0e7886 Update distinction between requestAnimationFrame and setTimeout(fn, 0) 2015-04-22 20:06:31 -07:00
Brent Vatne 8529b7bd6a Merge pull request #969 from artemyarulin/patch-1
[Docs] EmbeddedApp.md - index.ios.js has to be created inside ReactComponent
- In order to follow along with the rest of the example
2015-04-22 14:29:12 -07:00
Artem Yarulin 9913e421d7 index.ios.js has to be created inside ReactComponent 2015-04-22 17:27:25 +03:00
Thomas Treffry 7ee8d8b45c Update GettingStarted.md
Add missing full stops.
2015-04-21 19:45:38 -07:00
Spencer Ahrens eef40964da Merge pull request #958 from sahrens/nativeComponentGuide
Add Native Components guide.
2015-04-21 16:23:50 -07:00
Spencer Ahrens c5d367ad39 Add Native Components guide. 2015-04-21 16:22:32 -07:00
Alexander Kotliarskyi 4792707b23 Merge pull request #851 from arthuralee/master
Bundle script instead of curl
2015-04-21 15:15:20 -07:00
Amjad Masad eb76762a4c Watchman released 3.1 (no need for `--HEAD` install) 2015-04-20 17:34:59 -07:00
Arthur Lee 3adcc0322e Updated docs to reflect bundle script 2015-04-20 20:01:27 -04:00
Nick Lockwood 74252c9ec7 Update NativeModulesIOS.md
Updated documentation to include enhanced support for custom method types.
2015-04-19 18:04:45 +01:00
Herman Schaaf 49c928b76b [docs] change 'whenever' to 'whether' 2015-04-16 17:38:28 +09:00
James Ide d2b06138e7 [Docs] Fix formatting for "JavaScript method names" section in docs
Simple fix - GitHub's markdown is processed differently than Jekyll's, so just fixing things up to look better.
2015-04-15 14:07:00 -07:00
Jinghao Yan d1f42a82d2 Fix typo in NativeModulesIOS.md 2015-04-14 17:08:45 -07:00
James Ide 54dd54c2b9 [Docs] Add note about JS names for exported methods and RCT_REMAP_METHOD
Described how JS method names are derived from Obj-C selectors and mention RCT_REMAP_METHOD.
2015-04-12 02:44:34 -07:00
David Rabkin da3b982abe Update JavaScriptEnvironment.md
-fix grammar in a sentence
2015-04-10 19:18:04 -07:00
Brent Vatne 127649962d Replace RCT_EXPORT with RCT_EXPORT_METHOD 2015-04-10 13:23:59 -07:00
David Rabkin 7c0a332b81 Fix grammar in EmbeddedApp.md 2015-04-08 16:28:29 -07:00
Christopher Chedeau 1c7f39e461 Add JavaScript Environment in the docs and fix a few things 2015-04-08 11:06:56 -07:00
Christopher Chedeau e0a0bb1857 Create JavaScriptEnvironment.md 2015-04-08 10:56:20 -07:00
Christopher Chedeau fcd33c8825 Remove Twice for Cmd+R 2015-04-08 09:26:17 -07:00
Matthias Kühnle 308b88f417 Debugging on real devices
Added a hint about how to enable debugging on real devices.
2015-04-08 00:50:55 +02:00
Mike Wilcox 79fcbbfe09 Fixed typo 2015-04-06 22:41:17 -04:00
David Rabkin 851fae5a03 (docs) Update NativeModules.md 2015-04-03 20:57:56 -07:00
David Rabkin 6ee1f8cd50 (docs) Update Testing.md for punctuation 2015-04-03 20:27:43 -07:00
David Rabkin 9b178b8f1a (docs) Update Network.md for clarification 2015-04-03 20:26:55 -07:00