ModalBottomSheetLayout expands to EXPANDED state after first composition [200980998]

Fixed

Bug

Status Update

No update yet.

Description

jo...@jossiwolf.de

created issue #1

Sep 25, 2021 11:42AM

Hia!

When changing a ModalBottomSheetLayout's sheetContent and then calling ModalBottomSheetState#show directly after (from an effect), the sheet will expand to the EXPANDED state. It looks like the anchors aren't calculated correctly. You can repro it with this code:

@OptIn(ExperimentalMaterialApi::class)
private enum class State(
    val content: @Composable ColumnScope.(sheetState: ModalBottomSheetState) -> Unit
) {
    ONE(
        { SheetContent(items = 10, "test", it) }
    ),
    TWO(
        { SheetContent(items = 50, "test two", it) }
    )
}

@Sampled
@Composable
@OptIn(ExperimentalMaterialApi::class)
fun ModalBottomSheetSample() {
    val state = rememberModalBottomSheetState(ModalBottomSheetValue.Hidden)
    var sheetContent by remember { mutableStateOf<State?>(null) }
    ModalBottomSheetLayout(
        sheetState = state,
        sheetContent = {
            if (sheetContent != null ) {
                sheetContent!!.content(this, state)
            } else {
                Box(Modifier.height(1.dp))
            }
        }
    ) {
        Column(
            modifier = Modifier.fillMaxSize().padding(16.dp),
            horizontalAlignment = Alignment.CenterHorizontally
        ) {
            Text("Rest of the UI")
            Spacer(Modifier.height(20.dp))
            Button(
                onClick = {
                    sheetContent = when (sheetContent) {
                        State.ONE -> State.TWO
                        State.TWO -> State.ONE
                        null -> State.ONE
                    }
                }
            ) {
                Text("Click to show sheet")
            }
        }
    }
}

@OptIn(ExperimentalMaterialApi::class)
@Composable
private fun SheetContent(items: Int, prefix: String, sheetState: ModalBottomSheetState) {
    val scope = rememberCoroutineScope()
    DisposableEffect(items, prefix) {
        scope.launch {
            sheetState.show()
        }
        onDispose {
            scope.launch { sheetState.hide() }
        }
    }
    LazyColumn {
        items(items) {
            ListItem(
                text = { Text("$prefix $it") },
                icon = {
                    Icon(
                        Icons.Default.Favorite,
                        contentDescription = "Localized description"
                    )
                }
            )
        }
    }
}

The sheet should go to the HALF_EXPANDED state instead. I attached a video of the behavior.

Is there any workaround that you can think of?

sheet_expands_fully.mp4

2 MB

Download

Comments

jo...@jossiwolf.de <jo...@jossiwolf.de> #2Sep 25, 2021 12:46PM

Project: platform/frameworks/support
Branch: androidx-master-dev

commit c60f33e229e31ab328ef6b59dab63b264954831c
Author: Alexandre Elias <aelias@google.com>
Date: Fri Jul 10 16:23:09 2020

Semantics no-op cleanups

Partly in response to lmr's broad code review, I did a pass of
superficial API/implementation cleanup. The main changes are:

- I changed each Boolean SemanticsProperty where false is equivalent to
not being present to take "Unit" instead. This is conceptually
clearer: it avoids questions like "can I cancel out a semantics from a
merged child by setting it to false?" Because "property = Unit" looks
weird, I also changed the style of these to "property()".

- I moved the Semantics id generator closer to where it's used, in
SemanticsModifierCore. I made it internal and an AtomicInt.
(Note that integer ids are heavily used in the Android
AccessibilityNodeInfo APIs so I can't simply remove them entirely.)

- I deleted dead code. Some examples include SemanticsHintOverrides,
a public API not connected to anything, and SemanticsPropertyKey
merge() open method which is never called. (In both cases I have
a different plan in mind for accessibility.)

Fixes: 145951226
Fixes: 145955412
Test: existing tests
Relnote: "Single-value semantics properties now use a calling style.
For example, 'semantics { hidden = true }' is now written as:
'semantics { hidden() }'."

Change-Id: Ic1afd12ea22c926babc9662f1804d80b33aa0cfc

M ui/integration-tests/benchmark/src/androidTest/java/androidx/ui/benchmark/test/LayoutNodeModifierBenchmark.kt
M ui/ui-core/api/0.1.0-dev15.txt
M ui/ui-core/api/current.txt
M ui/ui-core/api/public_plus_experimental_0.1.0-dev15.txt
M ui/ui-core/api/public_plus_experimental_current.txt
M ui/ui-core/api/restricted_0.1.0-dev15.txt
M ui/ui-core/api/restricted_current.txt
M ui/ui-core/src/androidAndroidTest/kotlin/androidx/ui/graphics/vector/VectorTest.kt
M ui/ui-core/src/androidAndroidTest/kotlin/androidx/ui/semantics/SemanticsTests.kt
M ui/ui-core/src/androidMain/kotlin/androidx/ui/core/AndroidActuals.kt
M ui/ui-core/src/androidMain/kotlin/androidx/ui/core/AndroidComposeView.kt
M ui/ui-core/src/androidMain/kotlin/androidx/ui/core/AndroidComposeViewAccessibilityDelegateCompat.kt
M ui/ui-core/src/androidMain/kotlin/androidx/ui/core/AndroidPopup.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/Expect.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsConfiguration.kt
D ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsHintOverrides.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsModifier.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsNode.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsOwner.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsWrapper.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/semantics/SemanticsProperties.kt
M ui/ui-foundation/api/0.1.0-dev15.txt
M ui/ui-foundation/api/current.txt
M ui/ui-foundation/api/public_plus_experimental_0.1.0-dev15.txt
M ui/ui-foundation/api/public_plus_experimental_current.txt
M ui/ui-foundation/api/restricted_0.1.0-dev15.txt
M ui/ui-foundation/api/restricted_current.txt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/Clickable.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/Dialog.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/Scroller.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/selection/Selectable.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/selection/Toggleable.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/semantics/FoundationSemanticsProperties.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/ButtonTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/CardTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/CheckboxScreenshotTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/RadioButtonScreenshotTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/ScaffoldTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/SnackbarTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/SurfaceTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/ripple/RippleIndicationTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/textfield/TextFieldScreenshotTest.kt
M ui/ui-material/src/main/java/androidx/ui/material/AppBar.kt
M ui/ui-material/src/main/java/androidx/ui/material/TextFieldImpl.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/AssertsTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/CallSemanticsActionTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/ErrorMessagesTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/FindersTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/PrintToStringTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/ScrollToTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/TextActionsTest.kt
M ui/ui-test/src/main/java/androidx/ui/test/Actions.kt
M ui/ui-test/src/main/java/androidx/ui/test/Filters.kt
M ui/ui-text/api/0.1.0-dev15.txt
M ui/ui-text/api/current.txt
M ui/ui-text/api/public_plus_experimental_0.1.0-dev15.txt
M ui/ui-text/api/public_plus_experimental_current.txt
M ui/ui-text/api/restricted_0.1.0-dev15.txt
M ui/ui-text/api/restricted_current.txt
M ui/ui-text/src/commonMain/kotlin/androidx/ui/text/CoreTextField.kt
M ui/ui-text/src/commonMain/kotlin/androidx/ui/text/TextSemanticsProperties.kt

https://android-review.googlesource.com/1360099

ma...@google.com <ma...@google.com> #3Sep 28, 2021 05:44PM

From offline chat with Jossi:

Calling show from an effect with a sheet that fills the max height will result in the sheet being fully expanded Waiting for one frame - no difference Two frames - the show call gets cancelled Three frames - the sheet expands to the HALF_EXPANDED state as it's supposed to

nj...@google.com <nj...@google.com> Oct 5, 2021 09:36PM

Assigned to je...@google.com.

jo...@google.com <jo...@google.com> Nov 28, 2022 05:58PM

Reassigned to jo...@google.com.

ap...@google.com <ap...@google.com> #4Dec 5, 2022 08:03PM

Project: platform/frameworks/support
Branch: androidx-main

commit 082d1fb072944f1cb65e0bb4249e17804d670df0
Author: Jossi Wolf <jossiwolf@google.com>
Date: Fri Dec 02 13:13:07 2022

Remove ModalBottomSheetLayout expanded anchor when sheet empty

When the sheet is empty, we will now only have a Hidden anchor. This enables passing in empty sheet content if desired by the user.

Relnote: Fixed an issue where ModalBottomSheetLayout would crash if the sheet content was empty. ModalBottomSheetLayout now allows empty sheet content. If the sheet content is empty, it will only have a Hidden state.
Test: modalBottomSheet_anchorsChange_retainsCurrentValue, modalBottomSheet_emptySheet_expandDoesNotAnimate
Bug:

b/200980998

b/216693030

Change-Id: Ic2288017e3c5a80a0951cf136064cca5e2fab7cb

M compose/material/material/src/androidAndroidTest/kotlin/androidx/compose/material/ModalBottomSheetTest.kt
M compose/material/material/src/commonMain/kotlin/androidx/compose/material/ModalBottomSheet.kt

https://android-review.googlesource.com/2327674

jo...@google.com <jo...@google.com> Dec 5, 2022 08:14PM

Marked as fixed.

na...@google.com <na...@google.com> #5Jan 11, 2023 08:11PM

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

androidx.compose.material:material:1.4.0-alpha04