Better RTL support especially for ScrollView's

shergin · facebook-github-bot · commit 91910d87deb6 · 2017-02-02T09:58:30.000-08:00
Reviewed By: fkgozali

Differential Revision: D4478913

fbshipit-source-id: 525c17fa109ad3c35161b10940776f1426ba2535
diff --git a/Libraries/Components/ScrollView/ScrollView.js b/Libraries/Components/ScrollView/ScrollView.js
@@ -483,6 +483,30 @@ const ScrollView = React.createClass({
   },
 
   render: function() {
+    let ScrollViewClass;
+    let ScrollContentContainerViewClass;
+    if (Platform.OS === 'ios') {
+      ScrollViewClass = RCTScrollView;
+      ScrollContentContainerViewClass = RCTScrollContentView;
+    } else if (Platform.OS === 'android') {
+      if (this.props.horizontal) {
+        ScrollViewClass = AndroidHorizontalScrollView;
+      } else {
+        ScrollViewClass = AndroidScrollView;
+      }
+      ScrollContentContainerViewClass = View;
+    }
+
+    invariant(
+      ScrollViewClass !== undefined,
+      'ScrollViewClass must not be undefined'
+    );
+
+    invariant(
+      ScrollContentContainerViewClass !== undefined,
+      'ScrollContentContainerViewClass must not be undefined'
+    );
+
     const contentContainerStyle = [
       this.props.horizontal && styles.contentContainerHorizontal,
       this.props.contentContainerStyle,
@@ -507,14 +531,14 @@ const ScrollView = React.createClass({
     }
 
     const contentContainer =
-      <View
+      <ScrollContentContainerViewClass
         {...contentSizeChangeProps}
         ref={this._setInnerViewRef}
         style={contentContainerStyle}
         removeClippedSubviews={this.props.removeClippedSubviews}
         collapsable={false}>
         {this.props.children}
-      </View>;
+      </ScrollContentContainerViewClass>;
 
     const alwaysBounceHorizontal =
       this.props.alwaysBounceHorizontal !== undefined ?
@@ -559,21 +583,6 @@ const ScrollView = React.createClass({
       props.decelerationRate = processDecelerationRate(decelerationRate);
     }
 
-    let ScrollViewClass;
-    if (Platform.OS === 'ios') {
-      ScrollViewClass = RCTScrollView;
-    } else if (Platform.OS === 'android') {
-      if (this.props.horizontal) {
-        ScrollViewClass = AndroidHorizontalScrollView;
-      } else {
-        ScrollViewClass = AndroidScrollView;
-      }
-    }
-    invariant(
-      ScrollViewClass !== undefined,
-      'ScrollViewClass must not be undefined'
-    );
-
     const refreshControl = this.props.refreshControl;
     if (refreshControl) {
       if (Platform.OS === 'ios') {
@@ -626,7 +635,7 @@ const styles = StyleSheet.create({
   },
 });
 
-let nativeOnlyProps, AndroidScrollView, AndroidHorizontalScrollView, RCTScrollView;
+let nativeOnlyProps, AndroidScrollView, AndroidHorizontalScrollView, RCTScrollView, RCTScrollContentView;
 if (Platform.OS === 'android') {
   nativeOnlyProps = {
     nativeOnly: {
@@ -649,6 +658,7 @@ if (Platform.OS === 'android') {
     }
   };
   RCTScrollView = requireNativeComponent('RCTScrollView', ScrollView, nativeOnlyProps);
+  RCTScrollContentView = requireNativeComponent('RCTScrollContentView', View);
 }
 
 module.exports = ScrollView;
diff --git a/Libraries/Text/RCTTextField.m b/Libraries/Text/RCTTextField.m
@@ -227,6 +227,7 @@ - (void)textFieldEndEditing
                                       key:nil
                                eventCount:_nativeEventCount];
 }
+
 - (void)textFieldSubmitEditing
 {
   _submitted = YES;
diff --git a/React/Modules/RCTUIManager.m b/React/Modules/RCTUIManager.m
@@ -552,6 +552,7 @@ - (RCTViewManagerUIBlock)uiBlockWithLayoutUpdateForRootView:(RCTRootShadowView *
 
   typedef struct {
     CGRect frame;
+    UIUserInterfaceLayoutDirection layoutDirection;
     BOOL isNew;
     BOOL parentIsNew;
     BOOL isHidden;
@@ -568,6 +569,7 @@ - (RCTViewManagerUIBlock)uiBlockWithLayoutUpdateForRootView:(RCTRootShadowView *
       reactTags[index] = shadowView.reactTag;
       frameDataArray[index++] = (RCTFrameData){
         shadowView.frame,
+        shadowView.effectiveLayoutDirection,
         shadowView.isNewView,
         shadowView.superview.isNewView,
         shadowView.isHidden,
@@ -634,6 +636,7 @@ - (RCTViewManagerUIBlock)uiBlockWithLayoutUpdateForRootView:(RCTRootShadowView *
       CGRect frame = frameData.frame;
 
       BOOL isHidden = frameData.isHidden;
+      UIUserInterfaceLayoutDirection layoutDirection = frameData.layoutDirection;
       BOOL isNew = frameData.isNew;
       RCTAnimation *updateAnimation = isNew ? nil : layoutAnimation.updateAnimation;
       BOOL shouldAnimateCreation = isNew && !frameData.parentIsNew;
@@ -654,6 +657,10 @@ - (RCTViewManagerUIBlock)uiBlockWithLayoutUpdateForRootView:(RCTRootShadowView *
         view.hidden = isHidden;
       }
 
+      if (view.reactLayoutDirection != layoutDirection) {
+        view.reactLayoutDirection = layoutDirection;
+      }
+
       RCTViewManagerUIBlock updateBlock = updateBlocks[reactTag];
       if (createAnimation) {
 
diff --git a/React/Views/RCTScrollContentShadowView.h b/React/Views/RCTScrollContentShadowView.h
@@ -0,0 +1,16 @@
+/**
+ * Copyright (c) 2015-present, Facebook, Inc.
+ * All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ */
+
+#import <UIKit/UIKit.h>
+
+#import <React/RCTShadowView.h>
+
+@interface RCTScrollContentShadowView : RCTShadowView
+
+@end
diff --git a/React/Views/RCTScrollContentShadowView.m b/React/Views/RCTScrollContentShadowView.m
@@ -0,0 +1,55 @@
+/**
+ * Copyright (c) 2015-present, Facebook, Inc.
+ * All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ */
+
+#import "RCTScrollContentShadowView.h"
+
+#import <yoga/Yoga.h>
+
+#import "RCTUtils.h"
+
+@interface RCTShadowView () {
+  // This will be removed after t15757916, which will remove
+  // side-effects from `setFrame:` method.
+  @public CGRect _frame;
+}
+@end
+
+@implementation RCTScrollContentShadowView
+
+- (void)applyLayoutNode:(YGNodeRef)node
+      viewsWithNewFrame:(NSMutableSet<RCTShadowView *> *)viewsWithNewFrame
+       absolutePosition:(CGPoint)absolutePosition
+{
+  // Call super method if LTR layout is enforced.
+  if (self.effectiveLayoutDirection == UIUserInterfaceLayoutDirectionLeftToRight) {
+    [super applyLayoutNode:node
+         viewsWithNewFrame:viewsWithNewFrame
+          absolutePosition:absolutePosition];
+    return;
+  }
+
+  // Motivation:
+  // Yoga place `contentView` on the right side of `scrollView` when RTL layout is enfoced.
+  // That breaks everything; it is completly pointless to (re)position `contentView`
+  // because it is `contentView`'s job. So, we work around it here.
+
+  // Step 1. Compensate `absolutePosition` change.
+  CGFloat xCompensation = YGNodeLayoutGetRight(node) - YGNodeLayoutGetLeft(node);
+  absolutePosition.x += xCompensation;
+
+  // Step 2. Call super method.
+  [super applyLayoutNode:node
+       viewsWithNewFrame:viewsWithNewFrame
+        absolutePosition:absolutePosition];
+
+  // Step 3. Reset the position.
+  _frame.origin.x = RCTRoundPixelValue(YGNodeLayoutGetRight(node));
+}
+
+@end
diff --git a/React/Views/RCTScrollContentViewManager.h b/React/Views/RCTScrollContentViewManager.h
@@ -0,0 +1,14 @@
+/**
+ * Copyright (c) 2015-present, Facebook, Inc.
+ * All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ */
+
+#import <React/RCTViewManager.h>
+
+@interface RCTScrollContentViewManager : RCTViewManager
+
+@end
diff --git a/React/Views/RCTScrollContentViewManager.m b/React/Views/RCTScrollContentViewManager.m
@@ -0,0 +1,23 @@
+/**
+ * Copyright (c) 2015-present, Facebook, Inc.
+ * All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ */
+
+#import "RCTScrollContentViewManager.h"
+
+#import "RCTScrollContentShadowView.h"
+
+@implementation RCTScrollContentViewManager
+
+RCT_EXPORT_MODULE()
+
+- (RCTShadowView *)shadowView
+{
+  return [RCTScrollContentShadowView new];
+}
+
+@end
diff --git a/React/Views/RCTScrollView.m b/React/Views/RCTScrollView.m
@@ -159,6 +159,11 @@ - (instancetype)initWithFrame:(CGRect)frame
 {
   if ((self = [super initWithFrame:frame])) {
     [self.panGestureRecognizer addTarget:self action:@selector(handleCustomPan:)];
+
+    // We intentionaly force `UIScrollView`s `semanticContentAttribute` to `LTR` here
+    // because this attribute affects a position of vertical scrollbar; we don't want this
+    // scrollbar flip because we also flip it with whole `UIScrollView` flip.
+    self.semanticContentAttribute = UISemanticContentAttributeForceLeftToRight;
   }
   return self;
 }
@@ -191,7 +196,7 @@ - (void)handleCustomPan:(__unused UIPanGestureRecognizer *)sender
     self.panGestureRecognizer.enabled = YES;
     // TODO: If mid bounce, animate the scroll view to a non-bounced position
     // while disabling (but only if `stopScrollInteractionIfJSHasResponder` was
-    // called *during* a `pan`. Currently, it will just snap into place which
+    // called *during* a `pan`). Currently, it will just snap into place which
     // is not so bad either.
     // Another approach:
     // self.scrollEnabled = NO;
@@ -278,9 +283,10 @@ - (void)dockClosestSectionHeader
 {
   UIView *contentView = [self contentView];
   CGFloat scrollTop = self.bounds.origin.y + self.contentInset.top;
+
+#if !TARGET_OS_TV
   // If the RefreshControl is refreshing, remove it's height so sticky headers are
   // positioned properly when scrolling down while refreshing.
-#if !TARGET_OS_TV
   if (_rctRefreshControl != nil && _rctRefreshControl.refreshing) {
     scrollTop -= _rctRefreshControl.frame.size.height;
   }
@@ -451,6 +457,21 @@ - (instancetype)initWithEventDispatcher:(RCTEventDispatcher *)eventDispatcher
 RCT_NOT_IMPLEMENTED(- (instancetype)initWithFrame:(CGRect)frame)
 RCT_NOT_IMPLEMENTED(- (instancetype)initWithCoder:(NSCoder *)aDecoder)
 
+static inline void RCTApplyTranformationAccordingLayoutDirection(UIView *view, UIUserInterfaceLayoutDirection layoutDirection) {
+  view.transform =
+    layoutDirection == UIUserInterfaceLayoutDirectionLeftToRight ?
+      CGAffineTransformIdentity :
+      CGAffineTransformMakeScale(-1, 1);
+}
+
+- (void)setReactLayoutDirection:(UIUserInterfaceLayoutDirection)layoutDirection
+{
+  [super setReactLayoutDirection:layoutDirection];
+
+  RCTApplyTranformationAccordingLayoutDirection(_scrollView, layoutDirection);
+  RCTApplyTranformationAccordingLayoutDirection(_contentView, layoutDirection);
+}
+
 - (void)setRemoveClippedSubviews:(__unused BOOL)removeClippedSubviews
 {
   // Does nothing
@@ -467,6 +488,7 @@ - (void)insertReactSubview:(UIView *)view atIndex:(NSInteger)atIndex
   {
     RCTAssert(_contentView == nil, @"RCTScrollView may only contain a single subview");
     _contentView = view;
+    RCTApplyTranformationAccordingLayoutDirection(_contentView, self.reactLayoutDirection);
     [_scrollView addSubview:view];
   }
 }
@@ -921,16 +943,9 @@ - (CGSize)contentSize
 {
   if (!CGSizeEqualToSize(_contentSize, CGSizeZero)) {
     return _contentSize;
-  } else if (!_contentView) {
-    return CGSizeZero;
-  } else {
-    CGSize singleSubviewSize = _contentView.frame.size;
-    CGPoint singleSubviewPosition = _contentView.frame.origin;
-    return (CGSize){
-      singleSubviewSize.width + singleSubviewPosition.x,
-      singleSubviewSize.height + singleSubviewPosition.y
-    };
   }
+
+  return _contentView.frame.size;
 }
 
 - (void)reactBridgeDidFinishTransaction
diff --git a/React/Views/RCTShadowView.h b/React/Views/RCTShadowView.h
@@ -62,6 +62,11 @@ typedef void (^RCTApplierBlock)(NSDictionary<NSNumber *, UIView *> *viewRegistry
  */
 @property (nonatomic, assign, getter=isHidden) BOOL hidden;
 
+/**
+ * Computed layout direction for the view backed to Yoga node value.
+ */
+@property (nonatomic, assign, readonly) UIUserInterfaceLayoutDirection effectiveLayoutDirection;
+
 /**
  * Position and dimensions.
  * Defaults to { 0, 0, NAN, NAN }.
diff --git a/React/Views/RCTShadowView.m b/React/Views/RCTShadowView.m
@@ -438,6 +438,12 @@ - (NSString *)recursiveDescription
   return description;
 }
 
+// Layout Direction
+
+- (UIUserInterfaceLayoutDirection)effectiveLayoutDirection {
+  return YGNodeLayoutGetDirection(self.cssNode) == YGDirectionRTL ? UIUserInterfaceLayoutDirectionRightToLeft : UIUserInterfaceLayoutDirectionLeftToRight;
+}
+
 // Margin
 
 #define RCT_MARGIN_PROPERTY(prop, metaProp)       \
diff --git a/React/Views/RCTView.h b/React/Views/RCTView.h
@@ -40,6 +40,13 @@
  */
 + (UIEdgeInsets)contentInsetsForView:(UIView *)curView;
 
+/**
+ * Layout direction of the view.
+ * This is inherited from UIView+React, but we override it here
+ * to improve perfomance and make subclassing/overriding possible/easier.
+ */
+@property (nonatomic, assign) UIUserInterfaceLayoutDirection reactLayoutDirection;
+
 /**
  * z-index, used to override sibling order in didUpdateReactSubviews. This is
  * inherited from UIView+React, but we override it here to reduce the boxing
diff --git a/React/Views/RCTView.m b/React/Views/RCTView.m
@@ -124,6 +124,18 @@ - (instancetype)initWithFrame:(CGRect)frame
 
 RCT_NOT_IMPLEMENTED(- (instancetype)initWithCoder:unused)
 
+- (void)setReactLayoutDirection:(UIUserInterfaceLayoutDirection)layoutDirection
+{
+  _reactLayoutDirection = layoutDirection;
+
+#if __IPHONE_OS_VERSION_MIN_REQUIRED >= __IPHONE_9_0
+  self.semanticContentAttribute =
+    layoutDirection == UIUserInterfaceLayoutDirectionLeftToRight ?
+      UISemanticContentAttributeForceLeftToRight :
+      UISemanticContentAttributeForceRightToLeft;
+#endif
+}
+
 - (NSString *)accessibilityLabel
 {
   if (super.accessibilityLabel) {
diff --git a/React/Views/UIView+React.h b/React/Views/UIView+React.h
@@ -23,6 +23,13 @@
 - (void)insertReactSubview:(UIView *)subview atIndex:(NSInteger)atIndex NS_REQUIRES_SUPER;
 - (void)removeReactSubview:(UIView *)subview NS_REQUIRES_SUPER;
 
+/**
+ * Layout direction of the view.
+ * Internally backed to `semanticContentAttribute` property.
+ * Defaults to `LeftToRight` in case of ambiguity.
+ */
+@property (nonatomic, assign) UIUserInterfaceLayoutDirection reactLayoutDirection;
+
 /**
  * z-index, used to override sibling order in didUpdateReactSubviews.
  */
diff --git a/React/Views/UIView+React.m b/React/Views/UIView+React.m

Original file line number	Diff line number	Diff line change
`@@ -227,6 +227,7 @@ - (void)textFieldEndEditing`
`227`	`227`	`key:nil`
`228`	`228`	`eventCount:_nativeEventCount];`
`229`	`229`	`}`
	`230`	`+`
`230`	`231`	`- (void)textFieldSubmitEditing`
`231`	`232`	`{`
`232`	`233`	`_submitted = YES;`