mirror of
https://github.com/status-im/react-native.git
synced 2025-01-10 09:35:48 +00:00
e52cab5a7f
Summary:
Sometimes is handy to check if a React node is a descendant of another node or not. For instance, I want to check if the focused `TextInput` is descendant of an specific `ScrollView`:
```js
const currentlyFocusedField = TextInput.State.currentlyFocusedField()
UIManager.viewIsAncestorOf(
currentlyFocusedField,
this.getInnerViewNode(),
(isAncestor) => {
if (isAncestor) {
console.log('The focused field is a descendant of this ScrollView!')
}
}
)
```
This function uses the same strategy as the `measureLayout` method to check if one node is an ancestor of other node. As the `measureLayout` method, this is performed outside the main thread.
By now I've only implemented the iOS version and its tests, but if this function is going to be merged I'll implement the Android version too. I have objc experience but no Java or Android, so I prefer to validate this functionality before jumping into developing the Android part.
Closes https://github.com/facebook/react-native/pull/7876
Differential Revision: D3662045
Pulled By: javache
fbshipit-source-id: b9668e8ea94fd01db76651f16243926cf9c2566f
221 lines
8.2 KiB
Objective-C
221 lines
8.2 KiB
Objective-C
/**
|
|
* 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 <CSSLayout/CSSLayout.h>
|
|
#import "RCTComponent.h"
|
|
#import "RCTRootView.h"
|
|
|
|
@class RCTSparseArray;
|
|
|
|
typedef NS_ENUM(NSUInteger, RCTUpdateLifecycle) {
|
|
RCTUpdateLifecycleUninitialized = 0,
|
|
RCTUpdateLifecycleComputed,
|
|
RCTUpdateLifecycleDirtied,
|
|
};
|
|
|
|
typedef void (^RCTApplierBlock)(NSDictionary<NSNumber *, UIView *> *viewRegistry);
|
|
|
|
/**
|
|
* ShadowView tree mirrors RCT view tree. Every node is highly stateful.
|
|
* 1. A node is in one of three lifecycles: uninitialized, computed, dirtied.
|
|
* 1. RCTBridge may call any of the padding/margin/width/height/top/left setters. A setter would dirty
|
|
* the node and all of its ancestors.
|
|
* 2. At the end of each Bridge transaction, we call collectUpdatedFrames:widthConstraint:heightConstraint
|
|
* at the root node to recursively lay out the entire hierarchy.
|
|
* 3. If a node is "computed" and the constraint passed from above is identical to the constraint used to
|
|
* perform the last computation, we skip laying out the subtree entirely.
|
|
*/
|
|
@interface RCTShadowView : NSObject <RCTComponent>
|
|
|
|
/**
|
|
* RCTComponent interface.
|
|
*/
|
|
- (NSArray<RCTShadowView *> *)reactSubviews NS_REQUIRES_SUPER;
|
|
- (RCTShadowView *)reactSuperview NS_REQUIRES_SUPER;
|
|
- (void)insertReactSubview:(RCTShadowView *)subview atIndex:(NSInteger)atIndex NS_REQUIRES_SUPER;
|
|
- (void)removeReactSubview:(RCTShadowView *)subview NS_REQUIRES_SUPER;
|
|
|
|
@property (nonatomic, weak, readonly) RCTShadowView *superview;
|
|
@property (nonatomic, assign, readonly) CSSNodeRef cssNode;
|
|
@property (nonatomic, copy) NSString *viewName;
|
|
@property (nonatomic, strong) UIColor *backgroundColor; // Used to propagate to children
|
|
@property (nonatomic, copy) RCTDirectEventBlock onLayout;
|
|
|
|
/**
|
|
* isNewView - Used to track the first time the view is introduced into the hierarchy. It is initialized YES, then is
|
|
* set to NO in RCTUIManager after the layout pass is done and all frames have been extracted to be applied to the
|
|
* corresponding UIViews.
|
|
*/
|
|
@property (nonatomic, assign, getter=isNewView) BOOL newView;
|
|
|
|
/**
|
|
* isHidden - RCTUIManager uses this to determine whether or not the UIView should be hidden. Useful if the
|
|
* ShadowView determines that its UIView will be clipped and wants to hide it.
|
|
*/
|
|
@property (nonatomic, assign, getter=isHidden) BOOL hidden;
|
|
|
|
/**
|
|
* Position and dimensions.
|
|
* Defaults to { 0, 0, NAN, NAN }.
|
|
*/
|
|
@property (nonatomic, assign) CGFloat top;
|
|
@property (nonatomic, assign) CGFloat left;
|
|
@property (nonatomic, assign) CGFloat bottom;
|
|
@property (nonatomic, assign) CGFloat right;
|
|
|
|
@property (nonatomic, assign) CGFloat width;
|
|
@property (nonatomic, assign) CGFloat height;
|
|
|
|
@property (nonatomic, assign) CGFloat minWidth;
|
|
@property (nonatomic, assign) CGFloat maxWidth;
|
|
@property (nonatomic, assign) CGFloat minHeight;
|
|
@property (nonatomic, assign) CGFloat maxHeight;
|
|
|
|
@property (nonatomic, assign) CGRect frame;
|
|
|
|
- (void)setTopLeft:(CGPoint)topLeft;
|
|
- (void)setSize:(CGSize)size;
|
|
|
|
/**
|
|
* Set the natural size of the view, which is used when no explicit size is set.
|
|
* Use UIViewNoIntrinsicMetric to ignore a dimension.
|
|
*/
|
|
- (void)setIntrinsicContentSize:(CGSize)size;
|
|
|
|
/**
|
|
* Border. Defaults to { 0, 0, 0, 0 }.
|
|
*/
|
|
@property (nonatomic, assign) CGFloat borderWidth;
|
|
@property (nonatomic, assign) CGFloat borderTopWidth;
|
|
@property (nonatomic, assign) CGFloat borderLeftWidth;
|
|
@property (nonatomic, assign) CGFloat borderBottomWidth;
|
|
@property (nonatomic, assign) CGFloat borderRightWidth;
|
|
|
|
/**
|
|
* Margin. Defaults to { 0, 0, 0, 0 }.
|
|
*/
|
|
@property (nonatomic, assign) CGFloat margin;
|
|
@property (nonatomic, assign) CGFloat marginVertical;
|
|
@property (nonatomic, assign) CGFloat marginHorizontal;
|
|
@property (nonatomic, assign) CGFloat marginTop;
|
|
@property (nonatomic, assign) CGFloat marginLeft;
|
|
@property (nonatomic, assign) CGFloat marginBottom;
|
|
@property (nonatomic, assign) CGFloat marginRight;
|
|
|
|
/**
|
|
* Padding. Defaults to { 0, 0, 0, 0 }.
|
|
*/
|
|
@property (nonatomic, assign) CGFloat padding;
|
|
@property (nonatomic, assign) CGFloat paddingVertical;
|
|
@property (nonatomic, assign) CGFloat paddingHorizontal;
|
|
@property (nonatomic, assign) CGFloat paddingTop;
|
|
@property (nonatomic, assign) CGFloat paddingLeft;
|
|
@property (nonatomic, assign) CGFloat paddingBottom;
|
|
@property (nonatomic, assign) CGFloat paddingRight;
|
|
|
|
- (UIEdgeInsets)paddingAsInsets;
|
|
|
|
/**
|
|
* Flexbox properties. All zero/disabled by default
|
|
*/
|
|
@property (nonatomic, assign) CSSFlexDirection flexDirection;
|
|
@property (nonatomic, assign) CSSJustify justifyContent;
|
|
@property (nonatomic, assign) CSSAlign alignSelf;
|
|
@property (nonatomic, assign) CSSAlign alignItems;
|
|
@property (nonatomic, assign) CSSPositionType position;
|
|
@property (nonatomic, assign) CSSWrapType flexWrap;
|
|
@property (nonatomic, assign) CGFloat flex;
|
|
|
|
/**
|
|
* z-index, used to override sibling order in the view
|
|
*/
|
|
@property (nonatomic, assign) NSInteger zIndex;
|
|
|
|
/**
|
|
* Calculate property changes that need to be propagated to the view.
|
|
* The applierBlocks set contains RCTApplierBlock functions that must be applied
|
|
* on the main thread in order to update the view.
|
|
*/
|
|
- (void)collectUpdatedProperties:(NSMutableSet<RCTApplierBlock> *)applierBlocks
|
|
parentProperties:(NSDictionary<NSString *, id> *)parentProperties;
|
|
|
|
/**
|
|
* Process the updated properties and apply them to view. Shadow view classes
|
|
* that add additional propagating properties should override this method.
|
|
*/
|
|
- (NSDictionary<NSString *, id> *)processUpdatedProperties:(NSMutableSet<RCTApplierBlock> *)applierBlocks
|
|
parentProperties:(NSDictionary<NSString *, id> *)parentProperties NS_REQUIRES_SUPER;
|
|
|
|
/**
|
|
* Can be called by a parent on a child in order to calculate all views whose frame needs
|
|
* updating in that branch. Adds these frames to `viewsWithNewFrame`. Useful if layout
|
|
* enters a view where flex doesn't apply (e.g. Text) and then you want to resume flex
|
|
* layout on a subview.
|
|
*/
|
|
- (void)collectUpdatedFrames:(NSMutableSet<RCTShadowView *> *)viewsWithNewFrame
|
|
withFrame:(CGRect)frame
|
|
hidden:(BOOL)hidden
|
|
absolutePosition:(CGPoint)absolutePosition;
|
|
|
|
/**
|
|
* Apply the CSS layout.
|
|
* This method also calls `applyLayoutToChildren:` internally. The functionality
|
|
* is split into two methods so subclasses can override `applyLayoutToChildren:`
|
|
* while using default implementation of `applyLayoutNode:`.
|
|
*/
|
|
- (void)applyLayoutNode:(CSSNodeRef)node
|
|
viewsWithNewFrame:(NSMutableSet<RCTShadowView *> *)viewsWithNewFrame
|
|
absolutePosition:(CGPoint)absolutePosition NS_REQUIRES_SUPER;
|
|
|
|
/**
|
|
* Enumerate the child nodes and tell them to apply layout.
|
|
*/
|
|
- (void)applyLayoutToChildren:(CSSNodeRef)node
|
|
viewsWithNewFrame:(NSMutableSet<RCTShadowView *> *)viewsWithNewFrame
|
|
absolutePosition:(CGPoint)absolutePosition;
|
|
|
|
/**
|
|
* Return whether or not this node acts as a leaf node in the eyes of CSSLayout. For example
|
|
* RCTShadowText has children which it does not want CSSLayout to lay out so in the eyes of
|
|
* CSSLayout it is a leaf node.
|
|
*/
|
|
- (BOOL)isCSSLeafNode;
|
|
|
|
- (void)dirtyPropagation NS_REQUIRES_SUPER;
|
|
- (BOOL)isPropagationDirty;
|
|
|
|
- (void)dirtyText NS_REQUIRES_SUPER;
|
|
- (void)setTextComputed NS_REQUIRES_SUPER;
|
|
- (BOOL)isTextDirty;
|
|
|
|
/**
|
|
* As described in RCTComponent protocol.
|
|
*/
|
|
- (void)didUpdateReactSubviews NS_REQUIRES_SUPER;
|
|
- (void)didSetProps:(NSArray<NSString *> *)changedProps NS_REQUIRES_SUPER;
|
|
|
|
/**
|
|
* Computes the recursive offset, meaning the sum of all descendant offsets -
|
|
* this is the sum of all positions inset from parents. This is not merely the
|
|
* sum of `top`/`left`s, as this function uses the *actual* positions of
|
|
* children, not the style specified positions - it computes this based on the
|
|
* resulting layout. It does not yet compensate for native scroll view insets or
|
|
* transforms or anchor points.
|
|
*/
|
|
- (CGRect)measureLayoutRelativeToAncestor:(RCTShadowView *)ancestor;
|
|
|
|
/**
|
|
* Checks if the current shadow view is a descendant of the provided `ancestor`
|
|
*/
|
|
- (BOOL)viewIsDescendantOf:(RCTShadowView *)ancestor;
|
|
|
|
@end
|