From 4d3c3e625e97b6e3413aa05bb694b2d1b5e22cb1 Mon Sep 17 00:00:00 2001 From: Tj Date: Tue, 21 Jul 2015 16:46:40 -0400 Subject: [PATCH 1/2] Enum Constants Explanation Explains the use of `RCT_ENUM_CONVERTER` for using `NS_ENUM` arguments in exported functions --- docs/NativeModulesIOS.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/docs/NativeModulesIOS.md b/docs/NativeModulesIOS.md index acba1f05faf4eb..45f62997c82cf7 100644 --- a/docs/NativeModulesIOS.md +++ b/docs/NativeModulesIOS.md @@ -230,6 +230,43 @@ console.log(CalendarManager.firstDayOfTheWeek); Note that the constants are exported only at initialization time, so if you change `constantsToExport` values at runtime it won't affect the JavaScript environment. +###Enum Constants + +Enums that are defined via `NS_ENUM` cannot be used as method arguments without first extending RCTConvert. + +In order to export the following `NS_ENUM` definition: +```objc +typedef NS_ENUM(NSInteger, MyEnumType) +{ + kEnumOne, + kEnumTwo, +}; +``` + +You must create a class extension of RCTConvert like so: +```objc +@implementation RCTConvert (MyEnumExtension) + RCT_ENUM_CONVERTER(MyEnumType, (@{ @"enumOne" : @(kEnumOne), + @"enumTwo" : @(kEnumTwo), + kEnumOne, integerValue) +@end +``` + +You can then define methods and export your enum constants like this: + +```objc +- (NSDictionary *)constantsToExport +{ + return @{ @"enumOne" : @(kEnumOne), + @"enumTwo" : @(kEnumTwo) } +}; + +RCT_EXPORT_METHOD(doSomethingWithEnum:(MyEnumType)enum + completion:(RCTResponseSenderBlock)callback) +``` + +Your enum will then be automatically unwrapped using the selector provided (`integerValue` in the above example) before being passed to your exported method. + ## Sending Events to JavaScript From 1e5f22dc9c1b91d195f8872f7c9cab6f8ef30fa6 Mon Sep 17 00:00:00 2001 From: Tj Date: Tue, 21 Jul 2015 18:11:58 -0400 Subject: [PATCH 2/2] Updating for Code Review Using UIStatusBarAnimation for real world example --- docs/NativeModulesIOS.md | 30 +++++++++++++++++------------- 1 file changed, 17 insertions(+), 13 deletions(-) diff --git a/docs/NativeModulesIOS.md b/docs/NativeModulesIOS.md index 45f62997c82cf7..5dc26a93536567 100644 --- a/docs/NativeModulesIOS.md +++ b/docs/NativeModulesIOS.md @@ -230,25 +230,28 @@ console.log(CalendarManager.firstDayOfTheWeek); Note that the constants are exported only at initialization time, so if you change `constantsToExport` values at runtime it won't affect the JavaScript environment. -###Enum Constants +### Enum Constants Enums that are defined via `NS_ENUM` cannot be used as method arguments without first extending RCTConvert. In order to export the following `NS_ENUM` definition: + ```objc -typedef NS_ENUM(NSInteger, MyEnumType) -{ - kEnumOne, - kEnumTwo, +typedef NS_ENUM(NSInteger, UIStatusBarAnimation) { + UIStatusBarAnimationNone, + UIStatusBarAnimationFade, + UIStatusBarAnimationSlide, }; ``` You must create a class extension of RCTConvert like so: + ```objc -@implementation RCTConvert (MyEnumExtension) - RCT_ENUM_CONVERTER(MyEnumType, (@{ @"enumOne" : @(kEnumOne), - @"enumTwo" : @(kEnumTwo), - kEnumOne, integerValue) +@implementation RCTConvert (StatusBarAnimation) + RCT_ENUM_CONVERTER(UIStatusBarAnimation, (@{ @"statusBarAnimationNone" : @(UIStatusBarAnimationNone), + @"statusBarAnimationFade" : @(UIStatusBarAnimationFade), + @"statusBarAnimationSlide" : @(UIStatusBarAnimationSlide), + UIStatusBarAnimationNone, integerValue) @end ``` @@ -257,12 +260,13 @@ You can then define methods and export your enum constants like this: ```objc - (NSDictionary *)constantsToExport { - return @{ @"enumOne" : @(kEnumOne), - @"enumTwo" : @(kEnumTwo) } + return @{ @"statusBarAnimationNone" : @(UIStatusBarAnimationNone), + @"statusBarAnimationFade" : @(UIStatusBarAnimationFade), + @"statusBarAnimationSlide" : @(UIStatusBarAnimationSlide) } }; -RCT_EXPORT_METHOD(doSomethingWithEnum:(MyEnumType)enum - completion:(RCTResponseSenderBlock)callback) +RCT_EXPORT_METHOD(updateStatusBarAnimation:(UIStatusBarAnimation)animation + completion:(RCTResponseSenderBlock)callback) ``` Your enum will then be automatically unwrapped using the selector provided (`integerValue` in the above example) before being passed to your exported method.