Add can scroll metadata to ScrollableState [255557085]

Fixed

Feature Request

Status Update

No update yet.

Description

lp...@google.com

created issue #1

Oct 25, 2022 03:15PM

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)

Comments

lp...@google.com <lp...@google.com> #2Oct 25, 2022 03:24PM

Project: platform/frameworks/support
Branch: androidx-main
Author: Louis Pullen-Freilich <lpf@google.com>
Link: https://android-review.googlesource.com/3328184

Adds OverscrollEffect#withoutDrawing and OverscrollEffect#withoutEventHandling

Expand for full commit details

Adds OverscrollEffect#withoutDrawing and OverscrollEffect#withoutEventHandling 
 
These APIs allow overscroll to have events dispatched to it by one component, and rendered in a separate component. 
 
Fixes: b/266550551 
Fixes: b/204650733 
Fixes: b/255554340 
Fixes: b/229537244 
Test: OverscrollTest 
Relnote: "Adds OverscrollEffect#withoutDrawing and OverscrollEffect#withoutEventHandling APIs - these APIs create a wrapped instance of the provided overscroll effect that doesn't draw / handle events respectively, which allows for rendering  overscroll in a separate component from the component that is dispatching events. For example, disabling drawing the overscroll inside a lazy list, and then drawing the overscroll separately on top / elsewhere." 
Change-Id: Idbb3d91546b49c1987a041f959bce4b2b09a9f61

Files:

M compose/foundation/foundation/api/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/OverscrollDemo.kt
M compose/foundation/foundation/samples/src/main/java/androidx/compose/foundation/samples/OverscrollSample.kt
M compose/foundation/foundation/src/androidInstrumentedTest/kotlin/androidx/compose/foundation/OverscrollTest.kt
M compose/foundation/foundation/src/commonMain/kotlin/androidx/compose/foundation/Overscroll.kt

Hash: f64e25b7a473c757d080521e7dd97b3f6670f60d
Date: Fri Nov 01 18:43:56 2024

ap...@google.com <ap...@google.com> #3Nov 16, 2022 05:14PM

The following release(s) address this bug.It is possible this bug has only been partially addressed:

androidx.compose.foundation:foundation:1.8.0-alpha06
androidx.compose.foundation:foundation-android:1.8.0-alpha06
androidx.compose.foundation:foundation-jvmstubs:1.8.0-alpha06
androidx.compose.foundation:foundation-linuxx64stubs:1.8.0-alpha06

ap...@google.com <ap...@google.com> #4Nov 18, 2022 02:35PM

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:

b/255554340

Bug:

b/255557085

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

lp...@google.com <lp...@google.com> Sep 11, 2024 04:41PM

Marked as fixed.

Issue 255557085

Description

Issue summary

Comments

lp...@google.com <lp...@google.com> #2Oct 25, 2022 03:24PM

ap...@google.com <ap...@google.com> #3Nov 16, 2022 05:14PM

ap...@google.com <ap...@google.com> #4Nov 18, 2022 02:35PM

lp...@google.com <lp...@google.com> Sep 11, 2024 04:41PM

Add comment

Issue metadata