react-native-screens 5.0.0-alpha.1 → 5.0.0-alpha.2

package/ios/split/RNSSplitAppearanceApplicator.mm

@@ -0,0 +1,185 @@
+#import "RNSSplitAppearanceApplicator.h"
+
+#import <React/RCTAssert.h>
+#import "RNSDefines.h"
+#import "RNSScreenWindowTraits.h"
+#import "RNSSplitHostComponentView.h"
+#import "RNSSplitHostController.h"
+
+@implementation RNSSplitAppearanceApplicator
+
+- (void)updateAppearanceIfNeeded:(RNSSplitHostComponentView *)splitHost
+             splitHostController:(RNSSplitHostController *)splitHostController
+           appearanceCoordinator:(RNSSplitAppearanceCoordinator *)appearanceCoordinator
+{
+  __weak auto weakSelf = self;
+
+  [appearanceCoordinator updateIfNeeded:RNSSplitAppearanceUpdateFlagsGeneralUpdate
+                         updateCallback:^{
+                           auto strongSelf = weakSelf;
+                           if (strongSelf == nil) {
+                             return;
+                           }
+
+                           [strongSelf updateSplitViewConfigurationFor:splitHost withController:splitHostController];
+                         }];
+
+  [appearanceCoordinator updateIfNeeded:RNSSplitAppearanceUpdateFlagsSecondaryScreenNavBarUpdate
+                         updateCallback:^{
+                           auto strongSelf = weakSelf;
+                           if (strongSelf == nil) {
+                             return;
+                           }
+
+                           [splitHostController refreshSecondaryNavBar];
+                         }];
+
+  [appearanceCoordinator updateIfNeeded:RNSSplitAppearanceUpdateFlagsDisplayModeUpdate
+                         updateCallback:^{
+                           auto strongSelf = weakSelf;
+                           if (strongSelf == nil) {
+                             return;
+                           }
+
+                           [strongSelf updateSplitViewDisplayModeFor:splitHost withController:splitHostController];
+                         }];
+
+  [appearanceCoordinator updateIfNeeded:RNSSplitAppearanceUpdateFlagsOrientationUpdate
+                         updateCallback:^{
+                           [RNSScreenWindowTraits enforceDesiredDeviceOrientation];
+                         }];
+}
+
+/**
+ * @brief Function that applies all basic updates.
+ *
+ * It calls all setters on RNSSplitHostController that doesn't require any custom logic and conditions to be met.
+ *
+ * @param splitHost The view representing JS component which is sending updates.
+ * @param splitHostController The controller associated with the SplitView component which receives updates and
+ * manages the native layer.
+ */
+- (void)updateSplitViewConfigurationFor:(RNSSplitHostComponentView *)splitHost
+                         withController:(RNSSplitHostController *)splitHostController
+{
+  // Step 1 - general settings
+  splitHostController.displayModeButtonVisibility = splitHost.displayModeButtonVisibility;
+  splitHostController.preferredSplitBehavior = splitHost.preferredSplitBehavior;
+  splitHostController.overrideUserInterfaceStyle = splitHost.colorScheme;
+#if !TARGET_OS_TV
+  splitHostController.primaryBackgroundStyle = splitHost.primaryBackgroundStyle;
+#endif
+  splitHostController.presentsWithGesture = splitHost.presentsWithGesture;
+  splitHostController.primaryEdge = splitHost.primaryEdge;
+  splitHostController.showsSecondaryOnlyButton = splitHost.showSecondaryToggleButton;
+
+  // Step 2.1 - validating column constraints
+  [self validateColumnConstraintsWithMinWidth:splitHost.minimumPrimaryColumnWidth
+                                     maxWidth:splitHost.maximumPrimaryColumnWidth];
+
+  [self validateColumnConstraintsWithMinWidth:splitHost.minimumSupplementaryColumnWidth
+                                     maxWidth:splitHost.maximumSupplementaryColumnWidth];
+
+#if RNS_IPHONE_OS_VERSION_AVAILABLE(26_0) && !TARGET_OS_TV
+  if (@available(iOS 26.0, *)) {
+    [self validateColumnConstraintsWithMinWidth:splitHost.minimumInspectorColumnWidth
+                                       maxWidth:splitHost.maximumInspectorColumnWidth];
+  }
+#endif
+
+  // Step 2.2 - applying updates to columns
+  if (splitHost.minimumPrimaryColumnWidth >= 0) {
+    splitHostController.minimumPrimaryColumnWidth = splitHost.minimumPrimaryColumnWidth;
+  }
+
+  if (splitHost.maximumPrimaryColumnWidth >= 0) {
+    splitHostController.maximumPrimaryColumnWidth = splitHost.maximumPrimaryColumnWidth;
+  }
+
+  if (splitHost.preferredPrimaryColumnWidthOrFraction >= 0 && splitHost.preferredPrimaryColumnWidthOrFraction < 1) {
+    splitHostController.preferredPrimaryColumnWidthFraction = splitHost.preferredPrimaryColumnWidthOrFraction;
+  } else if (splitHost.preferredPrimaryColumnWidthOrFraction >= 1) {
+    splitHostController.preferredPrimaryColumnWidth = splitHost.preferredPrimaryColumnWidthOrFraction;
+  }
+
+  if (splitHost.minimumSupplementaryColumnWidth >= 0) {
+    splitHostController.minimumSupplementaryColumnWidth = splitHost.minimumSupplementaryColumnWidth;
+  }
+
+  if (splitHost.maximumSupplementaryColumnWidth >= 0) {
+    splitHostController.maximumSupplementaryColumnWidth = splitHost.maximumSupplementaryColumnWidth;
+  }
+
+  if (splitHost.preferredSupplementaryColumnWidthOrFraction >= 0 &&
+      splitHost.preferredSupplementaryColumnWidthOrFraction < 1) {
+    splitHostController.preferredSupplementaryColumnWidthFraction =
+        splitHost.preferredSupplementaryColumnWidthOrFraction;
+  } else if (splitHost.preferredSupplementaryColumnWidthOrFraction >= 1) {
+    splitHostController.preferredSupplementaryColumnWidth = splitHost.preferredSupplementaryColumnWidthOrFraction;
+  }
+
+#if RNS_IPHONE_OS_VERSION_AVAILABLE(26_0) && !TARGET_OS_TV
+  if (@available(iOS 26.0, *)) {
+    if (splitHost.minimumSecondaryColumnWidth >= 0) {
+      splitHostController.minimumSecondaryColumnWidth = splitHost.minimumSecondaryColumnWidth;
+    }
+
+    if (splitHost.preferredSecondaryColumnWidthOrFraction >= 0 &&
+        splitHost.preferredSecondaryColumnWidthOrFraction < 1) {
+      splitHostController.preferredSecondaryColumnWidthFraction = splitHost.preferredSecondaryColumnWidthOrFraction;
+    } else if (splitHost.preferredSecondaryColumnWidthOrFraction >= 1) {
+      splitHostController.preferredSecondaryColumnWidth = splitHost.preferredSecondaryColumnWidthOrFraction;
+    }
+
+    if (splitHost.minimumInspectorColumnWidth >= 0) {
+      splitHostController.minimumInspectorColumnWidth = splitHost.minimumInspectorColumnWidth;
+    }
+
+    if (splitHost.maximumInspectorColumnWidth >= 0) {
+      splitHostController.maximumInspectorColumnWidth = splitHost.maximumInspectorColumnWidth;
+    }
+
+    if (splitHost.preferredInspectorColumnWidthOrFraction >= 0 &&
+        splitHost.preferredInspectorColumnWidthOrFraction < 1) {
+      splitHostController.preferredInspectorColumnWidthFraction = splitHost.preferredInspectorColumnWidthOrFraction;
+    } else if (splitHost.preferredInspectorColumnWidthOrFraction >= 1) {
+      splitHostController.preferredInspectorColumnWidth = splitHost.preferredInspectorColumnWidthOrFraction;
+    }
+  }
+#endif
+
+  // Step 2.3 - manipulating with inspector column
+  [splitHostController toggleSplitViewInspector:splitHost.showInspector];
+}
+
+/**
+ * @brief Function that updates `preferredDisplayMode` property on SplitView.
+ *
+ * `preferredDisplayMode` needs to have a dedicated flag to prevent updates from the JS, when other props updates the
+ * appearance. It is crucial in the case, when `preferredDisplayMode` has changed due to some transition that was
+ * executed natively, e. g. after showing/hiding a column by a swipe. In that case, any prop update incoming, would
+ * reset `preferredDisplayMode` to the state from JS, what doesn't look good.
+ *
+ * @param splitHost The view representing JS component which is sending updates.
+ * @param splitHostController The controller associated with the SplitView component which receives updates and
+ * manages the native layer.
+ */
+- (void)updateSplitViewDisplayModeFor:(RNSSplitHostComponentView *)splitHost
+                       withController:(RNSSplitHostController *)splitHostController
+{
+  splitHostController.preferredDisplayMode = splitHost.preferredDisplayMode;
+}
+
+- (void)validateColumnConstraintsWithMinWidth:(CGFloat)minWidth maxWidth:(CGFloat)maxWidth
+{
+  // Compare values only if both are non-negative.
+  // The default value, which is -1, indicates that the constraint was not provided.
+  if (minWidth >= 0 && maxWidth >= 0) {
+    RCTAssert(minWidth <= maxWidth,
+              @"[RNScreens] Split column constraints are invalid: minWidth %f cannot be greater than maxWidth %f",
+              minWidth,
+              maxWidth);
+  }
+}
+
+@end

package/ios/split/RNSSplitAppearanceCoordinator.h

@@ -0,0 +1,26 @@
+#pragma once
+
+#import <Foundation/Foundation.h>
+#import "RNSSplitAppearanceUpdateFlags.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ * @brief - A class that is responsible for coordinating SplitHost appearance updates.
+ *
+ * It collects flags for Split appearance update actions and invalidates them.
+ * It's also responsible for executing callbacks when the action is requested.
+ */
+@interface RNSSplitAppearanceCoordinator : NSObject
+
+@property (nonatomic) RNSSplitAppearanceUpdateFlags updateFlags;
+
+- (void)needs:(RNSSplitAppearanceUpdateFlags)updateFlag;
+
+- (void)updateIfNeeded:(RNSSplitAppearanceUpdateFlags)updateFlag updateCallback:(void (^)(void))updateCallback;
+
+- (BOOL)isNeeded:(RNSSplitAppearanceUpdateFlags)updateFlag;
+
+@end
+
+NS_ASSUME_NONNULL_END

package/ios/split/RNSSplitAppearanceCoordinator.mm

@@ -0,0 +1,27 @@
+#import "RNSSplitAppearanceCoordinator.h"
+
+@implementation RNSSplitAppearanceCoordinator
+
+- (void)needs:(RNSSplitAppearanceUpdateFlags)updateFlag
+{
+  _updateFlags |= updateFlag;
+}
+
+/**
+ * Executes the update callback if the specified flag is set.
+ * The flag is cleared prior to execution to ensure the update only happens once per cycle.
+ */
+- (void)updateIfNeeded:(RNSSplitAppearanceUpdateFlags)updateFlag updateCallback:(void (^)(void))updateCallback
+{
+  if ([self isNeeded:updateFlag]) {
+    _updateFlags &= ~updateFlag;
+    updateCallback();
+  }
+}
+
+- (BOOL)isNeeded:(RNSSplitAppearanceUpdateFlags)updateFlag
+{
+  return (_updateFlags & updateFlag) == updateFlag;
+}
+
+@end

package/ios/split/RNSSplitAppearanceUpdateFlags.h

@@ -0,0 +1,14 @@
+#pragma once
+
+#import <Foundation/Foundation.h>
+
+/**
+ * @brief - A collection of flags, which can be invalidated on RNSSplitHostController to apply proper updates to
+ * SplitView
+ */
+typedef NS_OPTIONS(uint8_t, RNSSplitAppearanceUpdateFlags) {
+  RNSSplitAppearanceUpdateFlagsGeneralUpdate = 1 << 0,
+  RNSSplitAppearanceUpdateFlagsSecondaryScreenNavBarUpdate = 1 << 1,
+  RNSSplitAppearanceUpdateFlagsDisplayModeUpdate = 1 << 2,
+  RNSSplitAppearanceUpdateFlagsOrientationUpdate = 1 << 3,
+};

package/ios/split/RNSSplitHostComponentView.mm

@@ -8,8 +8,8 @@
 #import "RNSContainerHelpers.h"
 #import "RNSConversions.h"
 #import "RNSDefines.h"
+#import "RNSSplitHostController.h"
 #import "RNSSplitScreenComponentView.h"
-#import "Swift-Bridging.h"
 
 namespace react = facebook::react;
 

package/ios/split/RNSSplitHostController.h

@@ -0,0 +1,86 @@
+#pragma once
+
+#import <UIKit/UIKit.h>
+#import "RNSOrientationProviding.h"
+#import "RNSReactMountingTransactionObserving.h"
+
+@class RNSSplitHostComponentView;
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ * @class RNSSplitHostController
+ * @brief A controller associated with the RN native component representing Split host.
+ *
+ * Manages a collection of RNSSplitScreenComponentView instances,
+ * synchronizes appearance settings with props, observes component lifecycle, and emits events.
+ */
+@interface RNSSplitHostController
+    : UISplitViewController <RNSReactMountingTransactionObserving, RNSOrientationProviding>
+
+/**
+ * @brief Initializes the Split host controller with provided style.
+ *
+ * The style for the Split component can be passed only in the initialization method and cannot be changed dynamically.
+ *
+ * @param splitHostComponentView The view managed by this controller.
+ * @param numberOfColumns Expected number of visible columns.
+ */
+- (instancetype)initWithSplitHostComponentView:(RNSSplitHostComponentView *)splitHostComponentView
+                               numberOfColumns:(NSInteger)numberOfColumns;
+
+#pragma mark - Signals
+
+- (void)setNeedsUpdateOfChildViewControllers;
+
+- (void)setNeedsAppearanceUpdate;
+
+- (void)setNeedsSecondaryScreenNavBarUpdate;
+
+- (void)setNeedsDisplayModeUpdate;
+
+- (void)setNeedsOrientationUpdate;
+
+#pragma mark - Updating
+
+- (void)updateChildViewControllersIfNeeded;
+
+/**
+ * @brief Creates and attaches the Split child controllers based on the current React subviews.
+ *
+ * It validates constraints for Split hierarchy and it will crash after recognizing an invalid state,
+ * e. g. dynamically changed number of columns or number of columns that isn't between defined bounds.
+ * If Split constraints are met, it attaches SplitScreen representatives to SplitHost component.
+ */
+- (void)updateChildViewControllers;
+
+/**
+ * @brief Triggering appearance updates on secondary column's UINavigationBar component
+ *
+ * It validates that the secondary VC is valid UINavigationController and it updates the navbar
+ * state by toggling it's visibility, what should be performed in a single batch of updates.
+ */
+- (void)refreshSecondaryNavBar;
+
+#pragma mark - Public setters
+
+/**
+ * @brief Shows or hides the inspector screen.
+ * @remarks Inspector column is only available for iOS 26 or higher.
+ *
+ * @param showInspector Determines whether the inspector column should be visible.
+ */
+- (void)toggleSplitViewInspector:(BOOL)showInspector;
+
+/**
+ * @brief Programmatically shows a specific column identified by its string name.
+ *
+ * Maps the string column name to the corresponding `UISplitViewController.Column` and calls `show(_:)`.
+ *
+ * @param columnName A string representing the column to show: `"primary"`, `"supplementary"`, or `"secondary"`.
+ */
+- (void)showColumnNamed:(NSString *)columnName;
+
+@end
+
+NS_ASSUME_NONNULL_END