SearchBar inside Scaffold pushes/pulls UI elements below it upon expansion/contraction [350916229]

Fixed

Bug

Status Update

No update yet.

Description

dr...@gmail.com

created issue #1

Jul 4, 2024 07:08AM

Jetpack Compose version: BOM 2024.06.00

Material Library Version (M2, M3 or Both?): M3

Material Compose component used: SearchBar

Android Studio Build: 2024.1.1

Kotlin version: 2.0.0

Steps to Reproduce or Code Sample to Reproduce:

Put a SearchBar as topBar and a LazyColumn of items as content into a Scaffold.
Run the app and click on the SearchBar.
Notice that the expand animation of SearchBar pushes content below away instead of overlaying above it, and closing it pulls back the content below.
This is a result of SearchBar increasing its layout height in-place, which means the content will be given less height during measurement.

This can be seen in blog posts about how to use SearchBar as well, e.g. https://medium.com/@shivathapaa/custom-topappbar-using-android-jetpack-compose-f9b33388a125 (disclaimer: I'm not the author of it) has a GIF recording which shows this problem if one observe carefully.

This isn't a problem in Compose Material Catalog SearchBarSamples because the sample is using a Box and a fixed top padding for the list. However, that doesn't work in most real world scenarios e.g. when people need to use Scaffold.

I think the material-components-android approach for SearchBar, which is to offer SearchBar and SearchView separately, is more flexible and will make it possible to handle layout (and window insets） correctly under all scenarios.

Stack trace (if applicable): N/A

Comments

ke...@google.com <ke...@google.com> Jul 10, 2024 11:06PM

Reassigned to ma...@google.com.

ma...@google.com <ma...@google.com> Aug 13, 2024 05:37PM

Accepted by ma...@google.com.

ap...@google.com <ap...@google.com> #2Jan 29, 2025 07:08PM

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

ma...@google.com <ma...@google.com> #3Feb 6, 2025 04:14PM

Marked as fixed.

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

pr...@google.com <pr...@google.com> #4Feb 12, 2025 06:40PM

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

androidx.compose.material3:material3:1.4.0-alpha08
androidx.compose.material3:material3-android:1.4.0-alpha08
androidx.compose.material3:material3-jvmstubs:1.4.0-alpha08
androidx.compose.material3:material3-linuxx64stubs:1.4.0-alpha08
androidx.core:core-viewtree:1.0.0-rc01

Issue 350916229