Skip to content

Commit c87de76

Browse files
sahrensfacebook-github-bot
authored andcommitted
don't throttle below 16ms
Summary: For some reason the scroll events are sometimes generated with highly irregular spacing, some coming less than a millisecond apart. For interactions that must track scrolling exactly, this can cause them to glitch. With a scroll throttle of less than 17 ms, the intention is clear that the UI should be updated in sync with the scroll view so we shouldn't drop any events. Reviewed By: PeteTheHeat Differential Revision: D15068841 fbshipit-source-id: 730e7cb29cc3ddae66f37cf7392e02e0cc9d7844
1 parent 0a16b53 commit c87de76

File tree

3 files changed

+18
-8
lines changed

3 files changed

+18
-8
lines changed

Libraries/Animated/src/components/AnimatedScrollView.js

+3-1
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,6 @@ const ScrollView = require('ScrollView');
1414

1515
const createAnimatedComponent = require('createAnimatedComponent');
1616

17-
module.exports = createAnimatedComponent(ScrollView, {scrollEventThrottle: 16});
17+
module.exports = createAnimatedComponent(ScrollView, {
18+
scrollEventThrottle: 0.0001,
19+
});

Libraries/Components/ScrollView/ScrollView.js

+10-5
Original file line numberDiff line numberDiff line change
@@ -206,11 +206,16 @@ type IOSProps = $ReadOnly<{|
206206
* (as a time interval in ms). A lower number yields better accuracy for code
207207
* that is tracking the scroll position, but can lead to scroll performance
208208
* problems due to the volume of information being send over the bridge.
209-
* You will not notice a difference between values set between 1-16 as the
210-
* JS run loop is synced to the screen refresh rate. If you do not need precise
211-
* scroll position tracking, set this value higher to limit the information
212-
* being sent across the bridge. The default value is zero, which results in
213-
* the scroll event being sent only once each time the view is scrolled.
209+
*
210+
* Values between 0 and 17ms indicate 60fps updates are needed and throttling
211+
* will be disabled.
212+
*
213+
* If you do not need precise scroll position tracking, set this value higher
214+
* to limit the information being sent across the bridge.
215+
*
216+
* The default value is zero, which results in the scroll event being sent only
217+
* once each time the view is scrolled.
218+
*
214219
* @platform ios
215220
*/
216221
scrollEventThrottle?: ?number,

React/Views/ScrollView/RCTScrollView.m

+5-2
Original file line numberDiff line numberDiff line change
@@ -697,16 +697,19 @@ - (void)removeScrollListener:(NSObject<UIScrollViewDelegate> *)scrollListener
697697

698698
- (void)scrollViewDidScroll:(UIScrollView *)scrollView
699699
{
700-
[self updateClippedSubviews];
701700
NSTimeInterval now = CACurrentMediaTime();
701+
[self updateClippedSubviews];
702702
/**
703703
* TODO: this logic looks wrong, and it may be because it is. Currently, if _scrollEventThrottle
704704
* is set to zero (the default), the "didScroll" event is only sent once per scroll, instead of repeatedly
705705
* while scrolling as expected. However, if you "fix" that bug, ScrollView will generate repeated
706706
* warnings, and behave strangely (ListView works fine however), so don't fix it unless you fix that too!
707+
*
708+
* We limit the delta to 17ms so that small throttles intended to enable 60fps updates will not
709+
* inadvertantly filter out any scroll events.
707710
*/
708711
if (_allowNextScrollNoMatterWhat ||
709-
(_scrollEventThrottle > 0 && _scrollEventThrottle < (now - _lastScrollDispatchTime))) {
712+
(_scrollEventThrottle > 0 && _scrollEventThrottle < MAX(17, now - _lastScrollDispatchTime))) {
710713

711714
if (_DEPRECATED_sendUpdatedChildFrames) {
712715
// Calculate changed frames

0 commit comments

Comments
 (0)