Commit Graph

58 Commits

Author SHA1 Message Date
Joshua May 0f3d24c7fb Updates Swift @objc export for recent Swift versions
Summary:
As of Swift 3, [Swift converts Objective-C API names based on parameters](https://github.com/apple/swift-evolution/blob/master/proposals/0005-objective-c-name-translation.md), so the docs should explicitly declare what the Objective-C API is (because it's also used in the JavaScript side too).

An alternative to this would be to update the Objective-C and JavaScript calls to be `addEventWithName:location:date:` / `addEventWithName()` based on the default Swift API, but I think the approach in the PR is most correct here.
Closes https://github.com/facebook/react-native/pull/10176

Differential Revision: D4001604

Pulled By: hramos

fbshipit-source-id: cd4143d19d2d375288a086b9d7995e75fe1e9170
2016-10-11 07:43:52 -07:00
Tim Creasy 707aba822e Added RCTLog.h import for clarity
Summary:
Explicitly show import statements in example implementation file.  Xcode build fails unless RCTLog is imported.  Adding this clarifies this, as it is not stated anywhere else.
Closes https://github.com/facebook/react-native/pull/10117

Differential Revision: D3952631

Pulled By: javache

fbshipit-source-id: f268ff53ee2cf69aabd83c3305c5c25add338d83
2016-09-30 12:58:37 -07:00
Josh Hargreaves 66abc86c9a Doc. Update For Module Dependency Injection
Summary:
Added details about how IOS Native Modules can be initialized & registered manually with custom initializers so that dependencies can be injected to said modules.

Please let me know if there is a more appropriate place to detail this in the documentation or this is in fact detailed elsewhere; I also believe we do not have documentation on how to do the equivalent on Android, however it is a bit more obvious as the automatic MACRO registration mechanism does not exist on Android and modules need to be initialized manually anyway. As I currently understand there isn't currently any documentation detailing this apart from comments in the source.

Please let me know if you would require any style changes (variable names etc), to be more en-keeping with the rest of the documentation.
Closes https://github.com/facebook/react-native/pull/8406

Differential Revision: D3843018

Pulled By: javache

fbshipit-source-id: 5f4001df32d1ddc00a9dacc4fc99b63b408f1536
2016-09-09 12:28:46 -07:00
Arian Stolwijk a02c238464 Fix code example: NSNumber should be marked `nonnull` for compatibility with Android
Summary:
I was following the Native Modules guide for iOS, when I noticed this error in the example code:

> Argument 2 (NSNumber) of CalendarManager.addEvent has unspecified nullability but React requires that all NSNumber arguments are explicitly marked as `nonnull` to ensure compatibility with Android.

Marking the parameter NSNumber type as `nonnull` fixes the error in the example.
Closes https://github.com/facebook/react-native/pull/9705

Differential Revision: D3804661

Pulled By: JoelMarcey

fbshipit-source-id: 92ec8a08ff2a179e4a8935de4cecd7b8d993469b
2016-09-01 08:43:48 -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
sunnylqm 4301998e15 map -> object
Summary: Closes https://github.com/facebook/react-native/pull/8450

Differential Revision: D3488018

fbshipit-source-id: a30269c89e87b546f77da7a32b1c4c65d978459d
2016-06-27 03:13:23 -07:00
Alper Cugun 2fe67162ae Added objective-c class/module semantics
Summary:This really stumped me and I thought it could be added to the docs.
Closes https://github.com/facebook/react-native/pull/6136

Differential Revision: D2973912

Pulled By: mkonicek

fb-gh-sync-id: 0da1a946e2c2ad00056037a6492be3e99096582e
shipit-source-id: 0da1a946e2c2ad00056037a6492be3e99096582e
2016-03-08 07:07:27 -08:00
Xing Zheng b8850df31b typo with in code, replace date.toTime with date.getTime
Summary:There is no toTime method on a Date object, It should be getTime.
Closes https://github.com/facebook/react-native/pull/6054

Differential Revision: D2971217

fb-gh-sync-id: 4140be25f0704f251cc0e2f47db8fa83992dc0f0
shipit-source-id: 4140be25f0704f251cc0e2f47db8fa83992dc0f0
2016-02-24 06:20:32 -08:00
briancaw 5c18158aa9 Fixes NativeModules documentation typo
Reviewed By: svcscm

Differential Revision: D2938100

fb-gh-sync-id: f2a3a479fb504fdbbae3a864009e290ef9b5539d
shipit-source-id: f2a3a479fb504fdbbae3a864009e290ef9b5539d
2016-02-15 14:56:33 -08:00
Mateusz Zatorski 3ae99d0fea replace require with es6 import in docs
Reviewed By: svcscm

Differential Revision: D2936839

fb-gh-sync-id: 7a921709a37de5e9aadf324d5438d51851326348
shipit-source-id: 7a921709a37de5e9aadf324d5438d51851326348
2016-02-14 15:03:34 -08:00
Thomas Parslow b5579e807e Updated RCTPromiseRejectBlock example to use new 3 argument form
Reviewed By: svcscm

Differential Revision: D2931949

fb-gh-sync-id: d5da545c882e662f9c5d5b33cc3b152a4269bbb8
shipit-source-id: d5da545c882e662f9c5d5b33cc3b152a4269bbb8
2016-02-12 05:29:31 -08:00
Nader Dabit e2b035acf2 fixed documentation error for native modules docs page 2015-12-14 15:10:46 -06:00
zjlovezj e6c8848c07 fix sample code error by removing the extra chars
fix sample code error by removing the extra ',' and ')'
2015-12-12 19:21:31 +08:00
Satyajit Sahoo fdca4224bc Added docs on using Promisesin Native Modules 2015-11-24 02:51:51 +05:30
sunnylqm ab654b129f fix typo
fix: date.toTime() => date.getTime()
2015-11-11 11:06:40 +08:00
Divyendu Singh 484e6403b3 add missing curly brace in NativeModulesIOS.md 2015-10-25 01:04:59 +05:30
Nikita Gusakov e55b373a61 Split iOS and Android docs into different categories 2015-09-18 20:54:05 +03:00
Martin Konicek 42eb5464fd Release React Native for Android
This is an early release and there are several things that are known
not to work if you're porting your iOS app to Android.

See the Known Issues guide on the website.

We will work with the community to reach platform parity with iOS.
2015-09-14 18:13:39 +01: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
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
Amjad Masad e5ba0f388b Don't encourage the use of internal modules 2015-06-30 13:12:00 -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
Brent Vatne 731335eb7c [Docs] Add DeviceEventEmitter require to NativeModulesIOS docs 2015-05-27 09:43:44 -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 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 c5d367ad39 Add Native Components guide. 2015-04-21 16:22:32 -07: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
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
Brent Vatne 127649962d Replace RCT_EXPORT with RCT_EXPORT_METHOD 2015-04-10 13:23:59 -07:00
David Rabkin 851fae5a03 (docs) Update NativeModules.md 2015-04-03 20:57:56 -07:00
Loring Dodge f3c1f4220f Fix wording in NativeModulesIOS.md
Made small changes to the wording under  **NOTE**: About array and map
2015-04-02 20:52:42 -07:00
cclv ab997ebdde missing #import "RCTConvert.h" 2015-04-02 22:50:42 +08:00
cclv 9c26742743 missing #import "RCTLog.h" 2015-04-01 21:41:39 +08:00
Alexander Kotliarskyi 02298b59e2 Merge pull request #493 from tjwudi/patch-1
Add import RCTBridge.h for event sending example
2015-03-30 14:48:58 -07:00
Amjad Masad 60f61e8ee4 Merge pull request #301 from cahlan/patch-1
corrects typo in NativeModulesIOS README
2015-03-30 12:51:44 -07:00
John Wu 4f49271c28 Update NativeModulesIOS.md 2015-03-30 22:24:40 +08:00
John Wu 8df46c329b Add import RCTBridge.h for event sending example
The example omitted the `#import "RCTBridge.h"`, which will lead to CE.
2015-03-30 21:42:59 +08:00
Andre f7f1d71e0e Fix broken link 2015-03-30 17:31:48 +08:00
Christopher Chedeau 2fbe3c01ad fix website 2015-03-29 08:07:32 -07:00
Javier Bórquez a24123b950 Fix "next" link on NativeModules 2015-03-29 02:23:40 -06:00
Tadeu Zagallo dd9514200b [ReactNative][Docs] Document how to link libraries 2015-03-29 00:49:54 +00:00