Skip to content

Commit 8ea1cba

Browse files
robwalkercofacebook-github-bot
authored andcommitted
Remove iOS flag from scrollEventThrottle prop (facebook#35840)
Summary: The `scrollEventThrottle` prop is documented as only applying to iOS, but in [this commit](facebook@cf55fd5) it was also implemented for Android, but the documentation was not updated. ## Changelog [GENERAL] [CHANGED] - Removed iOS flag from `scrollEventThrottle` docs <!-- Help reviewers and the release process by writing your own changelog entry. Pick one each for the category and type tags: [ANDROID|GENERAL|IOS|INTERNAL] [BREAKING|ADDED|CHANGED|DEPRECATED|REMOVED|FIXED|SECURITY] - Message For more details, see: https://reactnative.dev/contributing/changelogs-in-pull-requests --> Pull Request resolved: facebook#35840 Test Plan: I've not been able to find how to build the docs locally, so I don't have a screenshot of the changes :( Reviewed By: cipolleschi Differential Revision: D42530943 Pulled By: sammy-SC fbshipit-source-id: 2948eca2621712ccd832f4f99f1aab0cbd4af2d0
1 parent 474c0ed commit 8ea1cba

File tree

1 file changed

+16
-19
lines changed

1 file changed

+16
-19
lines changed

Libraries/Components/ScrollView/ScrollView.js

Lines changed: 16 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -310,24 +310,6 @@ type IOSProps = $ReadOnly<{|
310310
* @platform ios
311311
*/
312312
pinchGestureEnabled?: ?boolean,
313-
/**
314-
* This controls how often the scroll event will be fired while scrolling
315-
* (as a time interval in ms). A lower number yields better accuracy for code
316-
* that is tracking the scroll position, but can lead to scroll performance
317-
* problems due to the volume of information being send over the bridge.
318-
*
319-
* Values between 0 and 17ms indicate 60fps updates are needed and throttling
320-
* will be disabled.
321-
*
322-
* If you do not need precise scroll position tracking, set this value higher
323-
* to limit the information being sent across the bridge.
324-
*
325-
* The default value is zero, which results in the scroll event being sent only
326-
* once each time the view is scrolled.
327-
*
328-
* @platform ios
329-
*/
330-
scrollEventThrottle?: ?number,
331313
/**
332314
* The amount by which the scroll view indicators are inset from the edges
333315
* of the scroll view. This should normally be set to the same value as
@@ -569,14 +551,29 @@ export type Props = $ReadOnly<{|
569551
* Note: Vertical pagination is not supported on Android.
570552
*/
571553
pagingEnabled?: ?boolean,
572-
573554
/**
574555
* When false, the view cannot be scrolled via touch interaction.
575556
* The default value is true.
576557
*
577558
* Note that the view can always be scrolled by calling `scrollTo`.
578559
*/
579560
scrollEnabled?: ?boolean,
561+
/**
562+
* This controls how often the scroll event will be fired while scrolling
563+
* (as a time interval in ms). A lower number yields better accuracy for code
564+
* that is tracking the scroll position, but can lead to scroll performance
565+
* problems due to the volume of information being send over the bridge.
566+
*
567+
* Values between 0 and 17ms indicate 60fps updates are needed and throttling
568+
* will be disabled.
569+
*
570+
* If you do not need precise scroll position tracking, set this value higher
571+
* to limit the information being sent across the bridge.
572+
*
573+
* The default value is zero, which results in the scroll event being sent only
574+
* once each time the view is scrolled.
575+
*/
576+
scrollEventThrottle?: ?number,
580577
/**
581578
* When true, shows a vertical scroll indicator.
582579
* The default value is true.

0 commit comments

Comments
 (0)