Stable theme support for overscroll glow [234451516]

Fixed

Feature Request

compose-roadmap-proposal

Status Update

No update yet.

Description

lp...@google.com

created issue #1

May 31, 2022 03:51PM

Currently the framework (and AppCompat / MDC by extension) use colorPrimary for the overscroll glow, with default alpha applied:

https://cs.android.com/android/platform/superproject/+/master:frameworks/base/core/java/android/widget/EdgeEffect.java;l=253

In order for Material to be able to properly theme this, we need to make OverScrollConfiguration or something similar stable API.

Comments

lp...@google.com <lp...@google.com> #2May 31, 2022 03:54PM

Probably need to expose the default alpha as well, so it is easy to replicate setting the color through xml, where the alpha is automatically applied (setting the color programatically does not apply the alpha).

ap...@google.com <ap...@google.com> #3Oct 17, 2024 02:13PM

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

Adds OverscrollFactory and LocalOverscrollFactory

Expand for full commit details

Adds OverscrollFactory and LocalOverscrollFactory

These APIs allow configuring the overscroll used by components within a hierarchy.

Also adds rememberOverscrollEffect to remember an OverscrollEffect from the current provided OverscrollFactory.

Bug: b/255554340
Bug: b/234451516
Test: OverscrollTest
Relnote: "Adds OverscrollFactory and LocalOverscrollFactory APIs to allow configuring overscroll within a hierarchy. The value provided through LocalOverscrollFactory will be used by default to create an OverscrollEffect. To create and remember an effect from the current provided factory, use rememberOverscrollEffect()."
Change-Id: I51ca476f3efcf0249640873f74cf7d40beebb788

Files:

M compose/foundation/foundation/api/current.txt
M compose/foundation/foundation/api/restricted_current.txt
M compose/foundation/foundation/src/androidInstrumentedTest/kotlin/androidx/compose/foundation/OverscrollTest.kt
M compose/foundation/foundation/src/androidMain/kotlin/androidx/compose/foundation/AndroidOverscroll.android.kt
M compose/foundation/foundation/src/commonMain/kotlin/androidx/compose/foundation/Overscroll.kt
M compose/foundation/foundation/src/commonMain/kotlin/androidx/compose/foundation/gestures/Scrollable.kt
M compose/foundation/foundation/src/commonStubsMain/kotlin/androidx/compose/foundation/DesktopOverscroll.commonStubs.kt

Hash: bbd406abf997857a050498d58bc85880832599aa
Date: Tue Oct 15 17:10:01 2024

lp...@google.com <lp...@google.com> #4Oct 30, 2024 10:35AM

R.e comment #2, looks like EdgeEffect ignores the provided color's alpha regardless, and sets a new alpha based on pull distance, so this comment can be ignored.

ap...@google.com <ap...@google.com> #5Oct 31, 2024 04:12PM

Marked as fixed.

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

Removes OverscrollConfiguration, adds rememberPlatformOverscrollFactory

Expand for full commit details

Removes OverscrollConfiguration, adds rememberPlatformOverscrollFactory 
 
Bug: b/255554340 
Fixes: b/234451516 
Test: updateApi 
Relnote: "Removes OverscrollConfiguration and LocalOverscrollConfiguration, and adds rememberPlatformOverscrollFactory to create an instance of / customize parameters of the default overscroll implementation. To disable overscroll, instead of `LocalOverscrollConfiguration provides null`, use `LocalOverscrollFactory provides null`. To change the glow color / padding, instead of `LocalOverscrollConfiguration provides OverscrollConfiguration(myColor, myPadding)`, use `LocalOverscrollFactory provides rememberPlatformOverscrollFactory(myColor, myPadding)`." 
Change-Id: Ie71f9a016face13262f4fe16ac56c40a0d6f9712

Files:

M compose/foundation/foundation/api/current.ignore
M compose/foundation/foundation/api/current.txt
M compose/foundation/foundation/api/restricted_current.ignore
M compose/foundation/foundation/api/restricted_current.txt
M compose/foundation/foundation/integration-tests/lazy-tests/src/androidTest/kotlin/androidx/compose/foundation/lazy/grid/LazyGridTest.kt
M compose/foundation/foundation/integration-tests/lazy-tests/src/androidTest/kotlin/androidx/compose/foundation/lazy/staggeredgrid/LazyStaggeredGridInLookaheadTest.kt
M compose/foundation/foundation/src/androidInstrumentedTest/kotlin/androidx/compose/foundation/pager/BasePagerTest.kt
M compose/foundation/foundation/src/androidInstrumentedTest/kotlin/androidx/compose/foundation/pager/SingleParamBasePagerTest.kt
M compose/foundation/foundation/src/androidMain/kotlin/androidx/compose/foundation/AndroidOverscroll.android.kt
D compose/foundation/foundation/src/androidMain/kotlin/androidx/compose/foundation/OverscrollConfiguration.android.kt
M compose/ui/ui-test/src/androidInstrumentedTest/kotlin/androidx/compose/ui/test/ComposeUiTestTest.kt
M compose/ui/ui-test/src/androidUnitTest/kotlin/androidx/compose/ui/test/RobolectricComposeTest.kt
M wear/compose/compose-foundation/build.gradle
M wear/compose/compose-foundation/src/androidTest/kotlin/androidx/wear/compose/foundation/rotary/RotaryTest.kt

Hash: 5556a50c11b544d5638bd88b1a3a20097e8d1152
Date: Wed Oct 30 19:30:40 2024

na...@google.com <na...@google.com> #6Nov 13, 2024 06:19PM

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
androidx.compose.ui:ui-test:1.8.0-alpha06
androidx.compose.ui:ui-test-android:1.8.0-alpha06
androidx.compose.ui:ui-test-jvmstubs:1.8.0-alpha06
androidx.compose.ui:ui-test-linuxx64stubs:1.8.0-alpha06
androidx.wear.compose:compose-foundation:1.5.0-alpha06

Issue 234451516