Skip to content

Commit

Permalink
Remove iOS flag from scrollEventThrottle prop (facebook#35840)
Browse files Browse the repository at this point in the history
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
  • Loading branch information
robwalkerco authored and OlimpiaZurek committed May 22, 2023
1 parent 783a9b6 commit 87e9f39
Showing 1 changed file with 16 additions and 19 deletions.
35 changes: 16 additions & 19 deletions Libraries/Components/ScrollView/ScrollView.js
Original file line number Diff line number Diff line change
Expand Up @@ -310,24 +310,6 @@ type IOSProps = $ReadOnly<{|
* @platform ios
*/
pinchGestureEnabled?: ?boolean,
/**
* This controls how often the scroll event will be fired while scrolling
* (as a time interval in ms). A lower number yields better accuracy for code
* that is tracking the scroll position, but can lead to scroll performance
* problems due to the volume of information being send over the bridge.
*
* Values between 0 and 17ms indicate 60fps updates are needed and throttling
* will be disabled.
*
* If you do not need precise scroll position tracking, set this value higher
* to limit the information being sent across the bridge.
*
* The default value is zero, which results in the scroll event being sent only
* once each time the view is scrolled.
*
* @platform ios
*/
scrollEventThrottle?: ?number,
/**
* The amount by which the scroll view indicators are inset from the edges
* of the scroll view. This should normally be set to the same value as
Expand Down Expand Up @@ -569,14 +551,29 @@ export type Props = $ReadOnly<{|
* Note: Vertical pagination is not supported on Android.
*/
pagingEnabled?: ?boolean,

/**
* When false, the view cannot be scrolled via touch interaction.
* The default value is true.
*
* Note that the view can always be scrolled by calling `scrollTo`.
*/
scrollEnabled?: ?boolean,
/**
* This controls how often the scroll event will be fired while scrolling
* (as a time interval in ms). A lower number yields better accuracy for code
* that is tracking the scroll position, but can lead to scroll performance
* problems due to the volume of information being send over the bridge.
*
* Values between 0 and 17ms indicate 60fps updates are needed and throttling
* will be disabled.
*
* If you do not need precise scroll position tracking, set this value higher
* to limit the information being sent across the bridge.
*
* The default value is zero, which results in the scroll event being sent only
* once each time the view is scrolled.
*/
scrollEventThrottle?: ?number,
/**
* When true, shows a vertical scroll indicator.
* The default value is true.
Expand Down

0 comments on commit 87e9f39

Please sign in to comment.