@rnx-kit/react-native-host 0.2.7 → 0.2.8

package/README.md

@@ -26,6 +26,10 @@ npm add --save-dev @rnx-kit/react-native-host
 
 ### iOS/macOS
 
+> To see a working example how to use this library for iOS/macOS, please refer
+> to
+> [react-native-test-app](https://github.com/microsoft/react-native-test-app/tree/trunk/ios/ReactTestApp).
+
 [Autolinking](https://github.com/react-native-community/cli/blob/10.x/docs/autolinking.md)
 should make this module available to your app project.
 
@@ -71,7 +75,7 @@ For example, if you previously had something like this:
 You should instead have:
 
 ```objc
-// AppDelegate.m
+// AppDelegate.h
 @import ReactNativeHost;
 @import UIKit;
 
@@ -95,3 +99,114 @@ You should instead have:
 
 @end
 ```
+
+## API
+
+### ReactNativeHost
+
+Instantiates the appropriate modules required for the setup. It handles New
+Architecture if necessary.
+
+#### `initWithConfig:`
+
+**Swift name:** `init(_:)`
+
+Creates an instance of `ReactNativeHost` using the designated initializer.
+
+Objective-C:
+
+```objc
+ReactNativeHost *host = [[ReactNativeHost alloc] initWithConfig:self];
+```
+
+Swift:
+
+```swift
+let host = ReactNativeHost(config: self)
+```
+
+#### `shutdown`
+
+Shuts down the React Native instance
+
+#### `usingModule:block:`
+
+**Swift name:** `using(module:block:)`
+
+Retrieves or initializes a desired native module. Parameters:
+
+- `moduleClass` - class of the native module to initialize or retrieve
+- `block` - block that gets called when the native module is retrieved
+
+Objective-C:
+
+```objc
+[host usingModule:[MyNativeModuleClass class] block:^(id<RCTBridgeModule> module) {
+    if (![module isKindOfClass:[MyNativeModuleClass class]]) {
+        return;
+    }
+    MyNativeModuleClass *myNativeModule = (MyNativeModuleClass *)module;
+    // Use the native module here
+}];
+```
+
+Swift:
+
+```swift
+host.using(module: MyNativeModuleClass.self) {
+  guard let myNativeModule = module as? MyNativeModuleClass else {
+    return
+  }
+  // Use the native module here
+}
+```
+
+#### `hostFromRootView:`
+
+**Swift name:** `host(from:)`
+
+Retrieves the `ReactNativeHost` instance that view belongs to.
+
+#### `viewWithModuleName:initialProperties:`
+
+**Swift name:** `view(moduleName:initialProperties:)`
+
+Creates a React root view with the specified module and initial properties.
+Parameters:
+
+- `moduleName` - name of the module to create root view of
+- `initialProperties` - properties passed to the module
+
+Objective-C:
+
+```objc
+ReactNativeHost *host = [[ReactNativeHost alloc] initWithConfig:self];
+UIView *rootView = [host viewWithModuleName:moduleName
+                          initialProperties:initialProperties];
+```
+
+Swift:
+
+```swift
+let view = host.view(
+    moduleName: moduleName,
+    initialProperties: initialProperties
+)
+```
+
+### RNXConfig
+
+`RNXHostConfig` is a superset of `RCTBridgeDelegate` and it's backwards
+compatible.
+
+#### `isDevLoadingViewEnabled`
+
+Returns whether the loading view should be visible while loading JavaScript
+
+#### `shouldReleaseBridgeWhenBackgrounded`
+
+Returns whether the bridge should be released when the app is in the background
+
+#### `onFatalError`
+
+Handles a fatal error

package/cocoa/RNXHostConfig.h

@@ -24,15 +24,6 @@ NS_ASSUME_NONNULL_BEGIN
              message:(NSString *)message
     __attribute__((__swift_name__("log(_:source:filename:line:message:)")));
 
-// Called when the bridge has been instantiated.
-- (void)onBridgeInstantiated:(RCTBridge *)bridge;
-
-// Called when the bridge is about to be shut down.
-- (void)onBridgeWillShutDown:(RCTBridge *)bridge;
-
-// Called when the bridge has been shut down.
-- (void)onBridgeDidShutDown;
-
 /// Handles a fatal error.
 - (void)onFatalError:(NSError *)error;
 

package/cocoa/ReactNativeHost.h

@@ -17,6 +17,9 @@ NS_ASSUME_NONNULL_BEGIN
 /// Hosts a React Native instance.
 @interface ReactNativeHost : NSObject <RCTBridgeDelegate>
 
+/// Returns the current `RCTBridge` instance.
+///
+/// - Note: This is not forwards compatible and will be removed in the future.
 @property (nonatomic, readonly, nullable) RCTBridge *bridge;
 
 - (instancetype)init NS_UNAVAILABLE;

package/cocoa/ReactNativeHost.mm

@@ -80,9 +80,6 @@
             _bridge = [[RCTBridge alloc] initWithDelegate:self launchOptions:nil];
             _surfacePresenterBridgeAdapter = RNXInstallSurfacePresenterBridgeAdapter(_bridge);
             [_hostReleaser setBridge:_bridge];
-            if ([_config respondsToSelector:@selector(onBridgeInstantiated:)]) {
-                [_config onBridgeInstantiated:_bridge];
-            }
         }
 
         return _bridge;
@@ -93,19 +90,11 @@
 
 - (void)shutdown
 {
-    if ([_config respondsToSelector:@selector(onBridgeWillShutDown:)]) {
-        [_config onBridgeWillShutDown:_bridge];
-    }
-
     [_isShuttingDown lock];
 
     @try {
         [_bridge invalidate];
         _bridge = nil;
-
-        if ([_config respondsToSelector:@selector(onBridgeDidShutDown)]) {
-            [_config onBridgeDidShutDown];
-        }
     } @finally {
         [_isShuttingDown unlock];
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rnx-kit/react-native-host",
-  "version": "0.2.7",
+  "version": "0.2.8",
   "description": "Simplify React Native initialization",
   "homepage": "https://github.com/microsoft/rnx-kit/tree/main/packages/react-native-host#readme",
   "license": "MIT",
@@ -19,10 +19,15 @@
     "directory": "packages/react-native-host"
   },
   "scripts": {
+    "format": "rnx-kit-scripts format",
     "format:c": "clang-format -i $(git ls-files '*.c' '*.cpp' '*.h' '*.m' '*.mm')",
     "lint:kt": "ktlint --relative --verbose 'android/src/**/*.kt'"
   },
   "peerDependencies": {
     "react-native": ">=0.64"
+  },
+  "devDependencies": {
+    "@rnx-kit/scripts": "*",
+    "prettier": "^3.0.0"
   }
 }