mirror of
https://github.com/facebook/react-native.git
synced 2025-11-01 09:14:26 +00:00
Craig_Martin
6f4239b37c
Summary: ScrollView's scrollTo behavior on iOS was recently changed to limit the offset to the content size plus any content inset (see #23427). This departure from the old behavior created UI issues for anyone that is using the over-scroll ability for the purpose of positioning elements at specific coordinates on the screen. Examples include using this behavior to position TextInputs above the virtual keyboard programmatically when focused or moving drop down elements positioned near the bottom of the content toward the top of the screen when selected to show a larger absolutely positioned item list. Default behavior does not change and this is an "opt-in" type of prop to re-enable the old behavior. [iOS] [Added] - Added scrollToOverflowEnabled prop to ScrollView Pull Request resolved: https://github.com/facebook/react-native/pull/24296 Differential Revision: D14762619 Pulled By: cpojer fbshipit-source-id: d2a552b5cb321d52e8ea4116327bf9ec647a3aae
80 lines
2.8 KiB
Objective-C
80 lines
2.8 KiB
Objective-C
/**
|
|
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
*
|
|
* This source code is licensed under the MIT license found in the
|
|
* LICENSE file in the root directory of this source tree.
|
|
*/
|
|
|
|
#import <UIKit/UIScrollView.h>
|
|
|
|
#import <React/RCTAutoInsetsProtocol.h>
|
|
#import <React/RCTEventDispatcher.h>
|
|
#import <React/RCTScrollableProtocol.h>
|
|
#import <React/RCTView.h>
|
|
|
|
@protocol UIScrollViewDelegate;
|
|
|
|
@interface RCTScrollView : RCTView <UIScrollViewDelegate, RCTScrollableProtocol, RCTAutoInsetsProtocol>
|
|
|
|
- (instancetype)initWithEventDispatcher:(RCTEventDispatcher *)eventDispatcher NS_DESIGNATED_INITIALIZER;
|
|
|
|
/**
|
|
* The `RCTScrollView` may have at most one single subview. This will ensure
|
|
* that the scroll view's `contentSize` will be efficiently set to the size of
|
|
* the single subview's frame. That frame size will be determined somewhat
|
|
* efficiently since it will have already been computed by the off-main-thread
|
|
* layout system.
|
|
*/
|
|
@property (nonatomic, readonly) UIView *contentView;
|
|
|
|
/**
|
|
* If the `contentSize` is not specified (or is specified as {0, 0}, then the
|
|
* `contentSize` will automatically be determined by the size of the subview.
|
|
*/
|
|
@property (nonatomic, assign) CGSize contentSize;
|
|
|
|
/**
|
|
* The underlying scrollView (TODO: can we remove this?)
|
|
*/
|
|
@property (nonatomic, readonly) UIScrollView *scrollView;
|
|
|
|
@property (nonatomic, assign) UIEdgeInsets contentInset;
|
|
@property (nonatomic, assign) BOOL automaticallyAdjustContentInsets;
|
|
@property (nonatomic, assign) BOOL DEPRECATED_sendUpdatedChildFrames;
|
|
@property (nonatomic, assign) NSTimeInterval scrollEventThrottle;
|
|
@property (nonatomic, assign) BOOL centerContent;
|
|
@property (nonatomic, copy) NSDictionary *maintainVisibleContentPosition;
|
|
@property (nonatomic, assign) BOOL scrollToOverflowEnabled;
|
|
@property (nonatomic, assign) int snapToInterval;
|
|
@property (nonatomic, copy) NSArray<NSNumber *> *snapToOffsets;
|
|
@property (nonatomic, assign) BOOL snapToStart;
|
|
@property (nonatomic, assign) BOOL snapToEnd;
|
|
@property (nonatomic, copy) NSString *snapToAlignment;
|
|
|
|
// NOTE: currently these event props are only declared so we can export the
|
|
// event names to JS - we don't call the blocks directly because scroll events
|
|
// need to be coalesced before sending, for performance reasons.
|
|
@property (nonatomic, copy) RCTDirectEventBlock onScrollBeginDrag;
|
|
@property (nonatomic, copy) RCTDirectEventBlock onScroll;
|
|
@property (nonatomic, copy) RCTDirectEventBlock onScrollToTop;
|
|
@property (nonatomic, copy) RCTDirectEventBlock onScrollEndDrag;
|
|
@property (nonatomic, copy) RCTDirectEventBlock onMomentumScrollBegin;
|
|
@property (nonatomic, copy) RCTDirectEventBlock onMomentumScrollEnd;
|
|
|
|
@end
|
|
|
|
@interface RCTScrollView (Internal)
|
|
|
|
- (void)updateContentOffsetIfNeeded;
|
|
|
|
@end
|
|
|
|
@interface RCTEventDispatcher (RCTScrollView)
|
|
|
|
/**
|
|
* Send a fake scroll event.
|
|
*/
|
|
- (void)sendFakeScrollEvent:(NSNumber *)reactTag;
|
|
|
|
@end
|