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

package/ios/stack/header/RNSStackHeaderMenuFinder.mm

@@ -25,6 +25,7 @@
                           headerItem:(nullable id<RNSStackHeaderItemDataProviding>)headerItem
                             rootMenu:(nullable RNSStackHeaderMenuData *)rootMenu
                        trackerItemId:(nullable NSString *)trackerItemId
+                inMenuRepresentation:(BOOL)inMenuRepresentation
 {
   if (self = [super init]) {
     _searchResult = searchResult;
@@ -32,6 +33,7 @@
     _headerItem = headerItem;
     _rootMenu = rootMenu;
     _trackerItemId = [trackerItemId copy];
+    _inMenuRepresentation = inMenuRepresentation;
   }
   return self;
 }
@@ -47,16 +49,30 @@
                                                 titleMenu:(nullable RNSStackHeaderMenuData *)titleMenu
 {
   for (id<RNSStackHeaderItemDataProviding> item in items) {
-    if (item.menu == nil || item.itemId == nil) {
+    if (item.itemId == nil) {
       continue;
     }
-    RNSStackHeaderMenuElementSearchResult *result = [self findElementWithId:elementId inMenu:item.menu];
-    if (result != nil) {
-      return [[RNSMenuElementLocator alloc] initWithSearchResult:result
-                                                        position:RNSMenuElementPositionItem
-                                                      headerItem:item
-                                                        rootMenu:item.menu
-                                                   trackerItemId:item.itemId];
+    if (item.menu != nil) {
+      RNSStackHeaderMenuElementSearchResult *result = [self findElementWithId:elementId inMenu:item.menu];
+      if (result != nil) {
+        return [[RNSMenuElementLocator alloc] initWithSearchResult:result
+                                                          position:RNSMenuElementPositionItem
+                                                        headerItem:item
+                                                          rootMenu:item.menu
+                                                     trackerItemId:item.itemId
+                                              inMenuRepresentation:NO];
+      }
+    }
+    if (item.menuRepresentation != nil) {
+      RNSStackHeaderMenuElementSearchResult *result = [self findElementWithId:elementId inMenu:item.menuRepresentation];
+      if (result != nil) {
+        return [[RNSMenuElementLocator alloc] initWithSearchResult:result
+                                                          position:RNSMenuElementPositionItem
+                                                        headerItem:item
+                                                          rootMenu:item.menuRepresentation
+                                                     trackerItemId:item.itemId
+                                              inMenuRepresentation:YES];
+      }
     }
   }
 
@@ -67,7 +83,8 @@
                                                         position:RNSMenuElementPositionTitle
                                                       headerItem:nil
                                                         rootMenu:titleMenu
-                                                   trackerItemId:RNSTitleMenuTrackerItemId];
+                                                   trackerItemId:RNSTitleMenuTrackerItemId
+                                            inMenuRepresentation:NO];
     }
   }
 

package/ios/stack/header/RNSStackHeaderMenuMapper.mm

@@ -88,18 +88,22 @@ static NSSet<NSString *> *const kRNSAllowedMenuItemKeys = [NSSet
 
 + (void)validateMenuKeys:(NSDictionary *)dict
 {
+#ifndef NS_BLOCK_ASSERTIONS
   for (NSString *key in dict) {
     RCTAssert([kRNSAllowedMenuKeys containsObject:key], @"[RNScreens] Invalid key \"%@\" found in menu", key);
   }
+#endif // !NS_BLOCK_ASSERTIONS
   RCTAssert(dict[@"children"], @"[RNScreens] missing key \"children\" in menu");
   RCTAssert(dict[@"id"], @"[RNScreens] missing id on one of menu elements");
 }
 
 + (void)validateMenuItemKeys:(NSDictionary *)dict
 {
+#ifndef NS_BLOCK_ASSERTIONS
   for (NSString *key in dict) {
     RCTAssert([kRNSAllowedMenuItemKeys containsObject:key], @"[RNScreens] Invalid key \"%@\" found in menu item", key);
   }
+#endif // !NS_BLOCK_ASSERTIONS
   RCTAssert(dict[@"id"], @"[RNScreens] missing id on one of menu elements");
 }
 

package/ios/stack/host/RNSStackNavigationBar.h

@@ -0,0 +1,25 @@
+#pragma once
+
+#import <UIKit/UIKit.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ * Navigation bar subclass used by RNSStackNavigationController.
+ *
+ * Its responsibility is to suppress the back button's navigation history
+ * menu (long press and pointer secondary click).
+ */
+@interface RNSStackNavigationBar : UINavigationBar
+
+#if !TARGET_OS_TV
+/**
+ * When NO, the back button's navigation history menu (long press and pointer
+ * secondary click) is suppressed. Tapping the back button is unaffected.
+ */
+@property (nonatomic) BOOL backButtonMenuEnabled;
+#endif // !TARGET_OS_TV
+
+@end
+
+NS_ASSUME_NONNULL_END

package/ios/stack/host/RNSStackNavigationBar.mm

@@ -0,0 +1,80 @@
+#import "RNSStackNavigationBar.h"
+#import "UINavigationBar+RNSUtility.h"
+
+static void *const RNSBackButtonMenuEnabledKVOContext = (void *)&RNSBackButtonMenuEnabledKVOContext;
+
+@implementation RNSStackNavigationBar
+#if !TARGET_OS_TV
+{
+  UIControl *_Nullable _observedBackButtonWrapper;
+}
+
+- (instancetype)initWithFrame:(CGRect)frame
+{
+  if (self = [super initWithFrame:frame]) {
+    _backButtonMenuEnabled = YES;
+  }
+  return self;
+}
+
+- (void)setBackButtonMenuEnabled:(BOOL)backButtonMenuEnabled
+{
+  _backButtonMenuEnabled = backButtonMenuEnabled;
+  [self enforceBackButtonMenuState];
+}
+
+- (void)layoutSubviews
+{
+  [super layoutSubviews];
+  // The back button wrapper may have been replaced by this layout pass
+  [self enforceBackButtonMenuState];
+}
+
+- (void)enforceBackButtonMenuState
+{
+  UIView *wrapperView = [self rnscreens_findBackButtonWrapperView];
+  if (wrapperView != _observedBackButtonWrapper) {
+    [_observedBackButtonWrapper removeObserver:self
+                                    forKeyPath:@"contextMenuInteractionEnabled"
+                                       context:RNSBackButtonMenuEnabledKVOContext];
+    _observedBackButtonWrapper = nil;
+
+    if ([wrapperView isKindOfClass:UIControl.class]) {
+      _observedBackButtonWrapper = (UIControl *)wrapperView;
+      [_observedBackButtonWrapper addObserver:self
+                                   forKeyPath:@"contextMenuInteractionEnabled"
+                                      options:NSKeyValueObservingOptionNew
+                                      context:RNSBackButtonMenuEnabledKVOContext];
+    }
+  }
+
+  _observedBackButtonWrapper.contextMenuInteractionEnabled = _backButtonMenuEnabled;
+}
+
+- (void)observeValueForKeyPath:(NSString *)keyPath
+                      ofObject:(id)object
+                        change:(NSDictionary<NSKeyValueChangeKey, id> *)change
+                       context:(void *)context
+{
+  if (context != RNSBackButtonMenuEnabledKVOContext) {
+    [super observeValueForKeyPath:keyPath ofObject:object change:change context:context];
+    return;
+  }
+
+  // UIKit re-asserts the interaction on every back button reconfigure
+  // - flip it back off immediately.
+  if (!_backButtonMenuEnabled && [change[NSKeyValueChangeNewKey] boolValue] && object == _observedBackButtonWrapper) {
+    _observedBackButtonWrapper.contextMenuInteractionEnabled = NO;
+  }
+}
+
+- (void)dealloc
+{
+  [_observedBackButtonWrapper removeObserver:self
+                                  forKeyPath:@"contextMenuInteractionEnabled"
+                                     context:RNSBackButtonMenuEnabledKVOContext];
+}
+
+#endif // !TARGET_OS_TV
+
+@end

package/ios/stack/host/RNSStackNavigationBarCoordinator.h

@@ -10,6 +10,14 @@ NS_ASSUME_NONNULL_BEGIN
     forNavigationController:(UINavigationController *)navigationController
                    animated:(BOOL)animated;
 
+#if !TARGET_OS_TV
+/**
+ * Enables or disables the back button's long-press navigation history menu.
+ * Takes effect only when the navigation bar is an RNSStackNavigationBar.
+ */
+- (void)setBackButtonMenuEnabled:(BOOL)enabled forNavigationController:(UINavigationController *)navigationController;
+#endif // !TARGET_OS_TV
+
 - (void)initializeNavigationBarOfNavigationController:(UINavigationController *)navigationController;
 
 @end

package/ios/stack/host/RNSStackNavigationBarCoordinator.mm

@@ -1,4 +1,6 @@
 #import "RNSStackNavigationBarCoordinator.h"
+#import <React/RCTAssert.h>
+#import "RNSStackNavigationBar.h"
 
 @implementation RNSStackNavigationBarCoordinator
 
@@ -9,6 +11,15 @@
   [navigationController setNavigationBarHidden:hidden animated:animated];
 }
 
+#if !TARGET_OS_TV
+- (void)setBackButtonMenuEnabled:(BOOL)enabled forNavigationController:(UINavigationController *)navigationController
+{
+  RCTAssert([navigationController.navigationBar isKindOfClass:RNSStackNavigationBar.class],
+            @"An instance of RNSStackNavigationBar is expected for navigation bar implementation");
+  static_cast<RNSStackNavigationBar *>(navigationController.navigationBar).backButtonMenuEnabled = enabled;
+}
+#endif // !TARGET_OS_TV
+
 - (void)initializeNavigationBarOfNavigationController:(UINavigationController *)navigationController
 {
 #if !TARGET_OS_TV

package/ios/stack/host/RNSStackNavigationController.mm

@@ -3,6 +3,7 @@
 #import "RNSContainer.h"
 #import "RNSLog.h"
 #import "RNSParentContainerItemRegistry.h"
+#import "RNSStackNavigationBar.h"
 #import "RNSStackOperation.h"
 #import "RNSStackScreenController.h"
 #import "RNSViewFrameChangeDelegate.h"
@@ -15,7 +16,12 @@
 
 - (instancetype)init
 {
-  if (self = [super init]) {
+#if !TARGET_OS_TV
+  self = [super initWithNavigationBarClass:RNSStackNavigationBar.class toolbarClass:nil];
+#else // !TARGET_OS_TV
+  self = [super init];
+#endif // !TARGET_OS_TV
+  if (self != nil) {
     _navigationBarCoordinator = [RNSStackNavigationBarCoordinator new];
     [_navigationBarCoordinator initializeNavigationBarOfNavigationController:self];
     [self initState];
@@ -102,15 +108,15 @@
     return;
   }
 
-  for (RNSPopOperation *op in _pendingPopOperations) {
-    UIViewController *controller = static_cast<UIViewController *>(op.stackScreen.controller);
+  for ([[maybe_unused]] RNSPopOperation *op in _pendingPopOperations) {
     RCTAssert([self.viewControllers count] > 1, @"[RNScreens] Attempt to pop last screen from the stack");
-    RCTAssert(self.topViewController == controller, @"[RNScreens] Attempt to pop non-top screen");
+    RCTAssert(self.topViewController == static_cast<UIViewController *>(op.stackScreen.controller),
+              @"[RNScreens] Attempt to pop non-top screen");
     [self popViewControllerAnimated:YES];
   }
 
   for (RNSPushOperation *op in _pendingPushOperations) {
-    UIViewController *controller = static_cast<UIViewController *>(op.stackScreen.controller);
+    RNSStackScreenController *controller = op.stackScreen.controller;
     [self pushViewController:controller animated:YES];
   }
 
@@ -126,10 +132,12 @@
 
 - (void)dumpStackModel
 {
+#ifdef RNS_DEBUG_LOGGING
   RNSLog(@"[RNScreens] StackContainer [%ld] MODEL BEGIN", self.view.tag);
   for (UIViewController *viewController in self.viewControllers) {
     RNSLog(@"[RNScreens] %@", static_cast<RNSStackScreenComponentView *>(viewController.view).screenKey);
   }
+#endif // RNS_DEBUG_LOGGING
 }
 
 @end

package/ios/stack/host/RNSStackOperation.h

@@ -18,8 +18,6 @@ NS_ASSUME_NONNULL_BEGIN
 
 @interface RNSPopOperation : RNSStackOperation
 
-@property (nonatomic, strong, readonly) RNSStackScreenComponentView *stackScreen;
-
 @end
 
 NS_ASSUME_NONNULL_END

package/ios/stack/screen/RNSStackScreenComponentView.h

@@ -1,6 +1,7 @@
 #pragma once
 
 #import "RNSReactBaseView.h"
+#import "RNSSafeAreaProviding.h"
 #import "RNSStackScreenComponentEventEmitter.h"
 
 NS_ASSUME_NONNULL_BEGIN
@@ -14,7 +15,7 @@ typedef NS_ENUM(int, RNSStackScreenActivityMode) {
   RNSStackScreenActivityModeAttached = 1,
 };
 
-@interface RNSStackScreenComponentView : RNSReactBaseView
+@interface RNSStackScreenComponentView : RNSReactBaseView <RNSSafeAreaProviding>
 
 @property (nonatomic, weak, readwrite, nullable) RNSStackHostComponentView *stackHost;
 @property (nonatomic, weak, readonly, nullable) RNSStackHeaderConfigComponentView *headerConfig;

package/ios/stack/screen/RNSStackScreenComponentView.mm

@@ -5,9 +5,10 @@
 #import <react/renderer/components/rnscreens/EventEmitters.h>
 #import <react/renderer/components/rnscreens/Props.h>
 #import <react/renderer/components/rnscreens/RCTComponentViewHelpers.h>
-#import <rnscreens/RNSStackScreenComponentDescriptor.h>
+#import <react/renderer/components/rnscreens/RNSStackScreenComponentDescriptor.h>
 
 #import "RNSConversions-Stack.h"
+#import "RNSSafeAreaViewNotifications.h"
 #import "RNSScrollViewMarkerComponentView.h"
 #import "RNSScrollViewSeeking.h"
 #import "RNSStackHeaderConfigComponentView.h"
@@ -107,6 +108,28 @@ namespace react = facebook::react;
   return _reactEventEmitter;
 }
 
+#pragma mark - RNSSafeAreaProviding
+
+- (UIEdgeInsets)providerSafeAreaInsets
+{
+  return self.safeAreaInsets;
+}
+
+- (void)dispatchSafeAreaDidChangeNotification
+{
+  [NSNotificationCenter.defaultCenter postNotificationName:RNSSafeAreaDidChange object:self userInfo:nil];
+}
+
+#pragma mark - RNSSafeAreaProviding related methods
+
+// TODO: register for UIKeyboard notifications
+
+- (void)safeAreaInsetsDidChange
+{
+  [super safeAreaInsetsDidChange];
+  [self dispatchSafeAreaDidChangeNotification];
+}
+
 #pragma mark - RCTComponentViewProtocol
 
 - (void)updateProps:(const facebook::react::Props::Shared &)props
@@ -116,7 +139,8 @@ namespace react = facebook::react;
   const auto &newComponentProps = *std::static_pointer_cast<const react::RNSStackScreenProps>(props);
 
   if (oldComponentProps.activityMode != newComponentProps.activityMode) {
-    _activityMode = rnscreens::conversion::convert<RNSStackScreenActivityMode>(newComponentProps.activityMode);
+    _activityMode = rnscreens::conversion::RNSStackScreenActivityModeFromReactRNSStackScreenActivityMode(
+        newComponentProps.activityMode);
     _hasUpdatedActivityMode = YES;
   }
 
@@ -132,6 +156,11 @@ namespace react = facebook::react;
 {
   if ([childComponentView isKindOfClass:RNSStackHeaderConfigComponentView.class]) {
     _headerConfig = (RNSStackHeaderConfigComponentView *)childComponentView;
+    _headerConfig.headerCoordinator = _controller.headerCoordinator;
+    _controller.headerCoordinator.configDataProvider = _headerConfig;
+    _controller.headerCoordinator.frameChangeDelegate = _headerConfig;
+    _controller.headerCoordinator.eventsDelegate = _headerConfig;
+    _controller.headerCoordinator.imageLoader = _headerConfig;
   }
   [super mountChildComponentView:childComponentView index:index];
 }
@@ -140,6 +169,7 @@ namespace react = facebook::react;
 {
   if ([childComponentView isKindOfClass:RNSStackHeaderConfigComponentView.class]) {
     [_controller.headerCoordinator clearHeaderConfiguration];
+    _headerConfig.headerCoordinator = nil;
     _headerConfig = nil;
   }
   [super unmountChildComponentView:childComponentView index:index];

package/ios/stack/screen/RNSStackScreenController.mm

@@ -56,6 +56,10 @@
 - (void)viewWillAppear:(BOOL)animated
 {
   [super viewWillAppear:animated];
+  [self.headerCoordinator updateNavigationBarVisibilityAnimated:animated];
+#if !TARGET_OS_TV
+  [self.headerCoordinator updateBackButtonMenuEnabled];
+#endif // !TARGET_OS_TV
   [[self reactEventEmitter] emitOnWillAppear];
 }
 
@@ -83,6 +87,14 @@
   [super didMoveToParentViewController:parent];
 
   if (parent == nil) {
+#if !TARGET_OS_TV
+    // The pop transition has completed. Clear the back button config this
+    // screen has applied onto the screen below. UIKit seems to serialize
+    // navigation transitions (undocumented, internal, but seems to work on 18 and 26),
+    // so this runs before a queued push applies its own config.
+    [_headerCoordinator clearAppliedBackButtonConfig];
+#endif // !TARGET_OS_TV
+
     if (_screenView.activityMode == RNSStackScreenActivityModeDetached) {
       [[self reactEventEmitter] emitOnDismiss];
     } else {

package/ios/stack/screen/RNSStackScreenHeaderCoordinator.h

@@ -42,6 +42,14 @@ NS_ASSUME_NONNULL_BEGIN
 
 - (void)clearHeaderConfiguration;
 
+- (void)updateNavigationBarVisibilityAnimated:(BOOL)animated;
+
+#if !TARGET_OS_TV
+- (void)updateBackButtonMenuEnabled;
+
+- (void)clearAppliedBackButtonConfig;
+#endif // !TARGET_OS_TV
+
 @end
 
 NS_ASSUME_NONNULL_END