Fixed
Status Update
No update yet.
Comments
lp...@google.com
Other API considerations: whether rememberScrollableState should have lambda parameter(s) to configure this
ap...@google.com
Project: platform/frameworks/support
Branch: androidx-main
commit 27fc48549dcbc370c57332b446b6c8a5f9dc9a4d
Author: Louis Pullen-Freilich <lpf@google.com>
Date: Tue Oct 25 17:05:43 2022
Adds canScrollForward and canScrollBackward to ScrollableState
Bug:
Test: existing tests
Relnote: "Adds ScrollableState#canScrollForward and ScrollableState#canScrollBackward to query whether a ScrollableState has room to scroll in either direction (whether it is at the minimum / maximum of its range). This defaults to true for backwards compatibility with existing implementations of ScrollableState. Consumers can use this to show indication to the user that there is still room to scroll, and this could also be used to avoid dispatching delta to ScrollableStates that have no room to scroll in a given direction, to reduce unnecessary work."
Change-Id: Idf1a066bdd86d2205d4bd5bab121c73059ada054
M compose/foundation/foundation/api/current.txt
M compose/foundation/foundation/api/public_plus_experimental_current.txt
M compose/foundation/foundation/api/restricted_current.txt
M compose/foundation/foundation/integration-tests/foundation-demos/src/main/java/androidx/compose/foundation/demos/FoundationDemos.kt
M compose/foundation/foundation/samples/src/main/java/androidx/compose/foundation/samples/ScrollableSamples.kt
M compose/foundation/foundation/src/androidAndroidTest/kotlin/androidx/compose/foundation/ScrollTest.kt
M compose/foundation/foundation/src/androidAndroidTest/kotlin/androidx/compose/foundation/lazy/grid/LazyScrollTest.kt
M compose/foundation/foundation/src/androidAndroidTest/kotlin/androidx/compose/foundation/lazy/list/LazyScrollTest.kt
M compose/foundation/foundation/src/androidAndroidTest/kotlin/androidx/compose/foundation/lazy/staggeredgrid/LazyStaggeredGridScrollTest.kt
M compose/foundation/foundation/src/commonMain/kotlin/androidx/compose/foundation/Scroll.kt
M compose/foundation/foundation/src/commonMain/kotlin/androidx/compose/foundation/gestures/ScrollableState.kt
M compose/foundation/foundation/src/commonMain/kotlin/androidx/compose/foundation/lazy/LazyListState.kt
M compose/foundation/foundation/src/commonMain/kotlin/androidx/compose/foundation/lazy/grid/LazyGridState.kt
M compose/foundation/foundation/src/commonMain/kotlin/androidx/compose/foundation/lazy/staggeredgrid/LazyStaggeredGridState.kt
M compose/foundation/foundation/src/commonMain/kotlin/androidx/compose/foundation/pager/PagerState.kt
M compose/foundation/foundation/src/commonMain/kotlin/androidx/compose/foundation/text/TextFieldScroll.kt
M tv/tv-foundation/api/current.txt
M tv/tv-foundation/api/public_plus_experimental_current.txt
M tv/tv-foundation/api/restricted_current.txt
M tv/tv-foundation/src/androidTest/java/androidx/tv/foundation/lazy/grid/LazyScrollTest.kt
M tv/tv-foundation/src/androidTest/java/androidx/tv/foundation/lazy/list/LazyScrollTest.kt
M tv/tv-foundation/src/main/java/androidx/tv/foundation/lazy/grid/TvLazyGridState.kt
M tv/tv-foundation/src/main/java/androidx/tv/foundation/lazy/list/LazyListState.kt
M wear/compose/compose-material/api/current.txt
M wear/compose/compose-material/api/public_plus_experimental_current.txt
M wear/compose/compose-material/api/restricted_current.txt
M wear/compose/compose-material/src/commonMain/kotlin/androidx/wear/compose/material/Picker.kt
M wear/compose/compose-material/src/commonMain/kotlin/androidx/wear/compose/material/ScalingLazyListState.kt
https://android-review.googlesource.com/2268949
Branch: androidx-main
commit 27fc48549dcbc370c57332b446b6c8a5f9dc9a4d
Author: Louis Pullen-Freilich <lpf@google.com>
Date: Tue Oct 25 17:05:43 2022
Adds canScrollForward and canScrollBackward to ScrollableState
Bug:
Test: existing tests
Relnote: "Adds ScrollableState#canScrollForward and ScrollableState#canScrollBackward to query whether a ScrollableState has room to scroll in either direction (whether it is at the minimum / maximum of its range). This defaults to true for backwards compatibility with existing implementations of ScrollableState. Consumers can use this to show indication to the user that there is still room to scroll, and this could also be used to avoid dispatching delta to ScrollableStates that have no room to scroll in a given direction, to reduce unnecessary work."
Change-Id: Idf1a066bdd86d2205d4bd5bab121c73059ada054
M compose/foundation/foundation/api/current.txt
M compose/foundation/foundation/api/public_plus_experimental_current.txt
M compose/foundation/foundation/api/restricted_current.txt
M compose/foundation/foundation/integration-tests/foundation-demos/src/main/java/androidx/compose/foundation/demos/FoundationDemos.kt
M compose/foundation/foundation/samples/src/main/java/androidx/compose/foundation/samples/ScrollableSamples.kt
M compose/foundation/foundation/src/androidAndroidTest/kotlin/androidx/compose/foundation/ScrollTest.kt
M compose/foundation/foundation/src/androidAndroidTest/kotlin/androidx/compose/foundation/lazy/grid/LazyScrollTest.kt
M compose/foundation/foundation/src/androidAndroidTest/kotlin/androidx/compose/foundation/lazy/list/LazyScrollTest.kt
M compose/foundation/foundation/src/androidAndroidTest/kotlin/androidx/compose/foundation/lazy/staggeredgrid/LazyStaggeredGridScrollTest.kt
M compose/foundation/foundation/src/commonMain/kotlin/androidx/compose/foundation/Scroll.kt
M compose/foundation/foundation/src/commonMain/kotlin/androidx/compose/foundation/gestures/ScrollableState.kt
M compose/foundation/foundation/src/commonMain/kotlin/androidx/compose/foundation/lazy/LazyListState.kt
M compose/foundation/foundation/src/commonMain/kotlin/androidx/compose/foundation/lazy/grid/LazyGridState.kt
M compose/foundation/foundation/src/commonMain/kotlin/androidx/compose/foundation/lazy/staggeredgrid/LazyStaggeredGridState.kt
M compose/foundation/foundation/src/commonMain/kotlin/androidx/compose/foundation/pager/PagerState.kt
M compose/foundation/foundation/src/commonMain/kotlin/androidx/compose/foundation/text/TextFieldScroll.kt
M tv/tv-foundation/api/current.txt
M tv/tv-foundation/api/public_plus_experimental_current.txt
M tv/tv-foundation/api/restricted_current.txt
M tv/tv-foundation/src/androidTest/java/androidx/tv/foundation/lazy/grid/LazyScrollTest.kt
M tv/tv-foundation/src/androidTest/java/androidx/tv/foundation/lazy/list/LazyScrollTest.kt
M tv/tv-foundation/src/main/java/androidx/tv/foundation/lazy/grid/TvLazyGridState.kt
M tv/tv-foundation/src/main/java/androidx/tv/foundation/lazy/list/LazyListState.kt
M wear/compose/compose-material/api/current.txt
M wear/compose/compose-material/api/public_plus_experimental_current.txt
M wear/compose/compose-material/api/restricted_current.txt
M wear/compose/compose-material/src/commonMain/kotlin/androidx/wear/compose/material/Picker.kt
M wear/compose/compose-material/src/commonMain/kotlin/androidx/wear/compose/material/ScalingLazyListState.kt
ap...@google.com
Project: platform/frameworks/support
Branch: androidx-main
commit 322dff0ce2e931fd6c92abe1227fdcd45af72b3c
Author: Louis Pullen-Freilich <lpf@google.com>
Date: Tue Nov 15 18:28:19 2022
Removes OverscrollEffect#isEnabled
Instead of layouts configuring whether overscroll is enabled or not based on available scroll space, instead it should be the responsibility of the caller that dispatches events to overscroll, based on information such as ScrollableState#canScrollForward / canScrollBackward. This simplifies the overscroll APIs and also prevents issues such as trying to manually dispatch events to overscroll without remembering to call isEnabled = true first.
Bug:
Bug:
Test: OverscrollTest
Relnote: "Removed OverscrollEffect#isEnabled. Instead of needing to remember and set this flag, just don't dispatch events to the overscroll effect in cases where you do not want overscroll to show (for example if ScrollableState#canScrollForward/backward both return false)."
Change-Id: I1a4b07627dca47f13d7adb7481fd25097b6eb6a9
M compose/foundation/foundation/api/public_plus_experimental_current.txt
M compose/foundation/foundation/benchmark/src/androidTest/java/androidx/compose/foundation/benchmark/OverscrollBenchmark.kt
M compose/foundation/foundation/samples/src/main/java/androidx/compose/foundation/samples/OverscrollSample.kt
M compose/foundation/foundation/src/androidAndroidTest/kotlin/androidx/compose/foundation/OverscrollTest.kt
M compose/foundation/foundation/src/androidAndroidTest/kotlin/androidx/compose/foundation/ScrollableTest.kt
M compose/foundation/foundation/src/androidMain/kotlin/androidx/compose/foundation/AndroidOverscroll.kt
M compose/foundation/foundation/src/commonMain/kotlin/androidx/compose/foundation/Overscroll.kt
M compose/foundation/foundation/src/commonMain/kotlin/androidx/compose/foundation/Scroll.kt
M compose/foundation/foundation/src/commonMain/kotlin/androidx/compose/foundation/gestures/Scrollable.kt
M compose/foundation/foundation/src/commonMain/kotlin/androidx/compose/foundation/lazy/LazyList.kt
M compose/foundation/foundation/src/commonMain/kotlin/androidx/compose/foundation/lazy/grid/LazyGrid.kt
M compose/foundation/foundation/src/commonMain/kotlin/androidx/compose/foundation/lazy/staggeredgrid/LazyStaggeredGrid.kt
M compose/foundation/foundation/src/commonMain/kotlin/androidx/compose/foundation/lazy/staggeredgrid/LazyStaggeredGridMeasurePolicy.kt
M compose/foundation/foundation/src/desktopMain/kotlin/androidx/compose/foundation/DesktopOverscroll.kt
https://android-review.googlesource.com/2302485
Branch: androidx-main
commit 322dff0ce2e931fd6c92abe1227fdcd45af72b3c
Author: Louis Pullen-Freilich <lpf@google.com>
Date: Tue Nov 15 18:28:19 2022
Removes OverscrollEffect#isEnabled
Instead of layouts configuring whether overscroll is enabled or not based on available scroll space, instead it should be the responsibility of the caller that dispatches events to overscroll, based on information such as ScrollableState#canScrollForward / canScrollBackward. This simplifies the overscroll APIs and also prevents issues such as trying to manually dispatch events to overscroll without remembering to call isEnabled = true first.
Bug:
Bug:
Test: OverscrollTest
Relnote: "Removed OverscrollEffect#isEnabled. Instead of needing to remember and set this flag, just don't dispatch events to the overscroll effect in cases where you do not want overscroll to show (for example if ScrollableState#canScrollForward/backward both return false)."
Change-Id: I1a4b07627dca47f13d7adb7481fd25097b6eb6a9
M compose/foundation/foundation/api/public_plus_experimental_current.txt
M compose/foundation/foundation/benchmark/src/androidTest/java/androidx/compose/foundation/benchmark/OverscrollBenchmark.kt
M compose/foundation/foundation/samples/src/main/java/androidx/compose/foundation/samples/OverscrollSample.kt
M compose/foundation/foundation/src/androidAndroidTest/kotlin/androidx/compose/foundation/OverscrollTest.kt
M compose/foundation/foundation/src/androidAndroidTest/kotlin/androidx/compose/foundation/ScrollableTest.kt
M compose/foundation/foundation/src/androidMain/kotlin/androidx/compose/foundation/AndroidOverscroll.kt
M compose/foundation/foundation/src/commonMain/kotlin/androidx/compose/foundation/Overscroll.kt
M compose/foundation/foundation/src/commonMain/kotlin/androidx/compose/foundation/Scroll.kt
M compose/foundation/foundation/src/commonMain/kotlin/androidx/compose/foundation/gestures/Scrollable.kt
M compose/foundation/foundation/src/commonMain/kotlin/androidx/compose/foundation/lazy/LazyList.kt
M compose/foundation/foundation/src/commonMain/kotlin/androidx/compose/foundation/lazy/grid/LazyGrid.kt
M compose/foundation/foundation/src/commonMain/kotlin/androidx/compose/foundation/lazy/staggeredgrid/LazyStaggeredGrid.kt
M compose/foundation/foundation/src/commonMain/kotlin/androidx/compose/foundation/lazy/staggeredgrid/LazyStaggeredGridMeasurePolicy.kt
M compose/foundation/foundation/src/desktopMain/kotlin/androidx/compose/foundation/DesktopOverscroll.kt
Description
Currently we have canScrollForward / canScrollBackward state in lazy* APIs - this would be generically useful for all scrollable components and would allow developers to more easily implement features such as scroll to top / bottom buttons, indicators to show that there is more scrollable content in a certain direction and buttons (such as arrows in a scroll bar) to manually scroll by a fixed delta.
It would also allow us to make other performance / optimization improvements that would be worth investigating:
Only dispatch scroll deltas if we can scroll in that direction (i.e we are not at the end of the scrollable component)
Not dispatch scroll deltas or overscroll if we can scroll in neither direction (e.g the scrollable bounds are smaller than the viewport)