Material3 PullToRefresh doesn't preserve state across configuration changes. [317177684]

Fixed

Bug

Status Update

No update yet.

Description

ab...@gmail.com

created issue #1

Dec 20, 2023 09:40PM

Jetpack Compose version: 1.6.0-alpha08

Jetpack Compose component used: androidx.compose.material3:material3:1.2.0-alpha11

Android Studio Build: Android Studio Hedgehog Build #AI-231.9392.1.2311.11076708.

Kotlin version: 1.9.20

PullToRefresh doesn't preserve its state properly between configuration changes (e.g screen rotation)

Minimal sample to reproduce the bug:

class MainActivity : ComponentActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)

        setContent {
            PullToRefreshSample()
        }
    }
}

@OptIn(ExperimentalMaterial3Api::class)
@Composable
fun PullToRefreshSample() {
    var itemCount by rememberSaveable { mutableIntStateOf(15) }
    val state = rememberPullToRefreshState()
    if (state.isRefreshing) {
        LaunchedEffect(true) {
            // fetch something
            delay(2500)
            itemCount += 5
            state.endRefresh()
        }
    }
    Box(Modifier.nestedScroll(state.nestedScrollConnection)) {
        LazyColumn(Modifier.fillMaxSize()) {
            if (!state.isRefreshing) {
                items(itemCount) {
                    ListItem({ Text(text = "Item ${itemCount - it}") })
                }
            }
        }
        PullToRefreshContainer(
            modifier = Modifier.align(Alignment.TopCenter),
            state = state,
        )
    }
}

Steps to Reproduce or Code Sample to Reproduce:

Run the above code snippet on any android device.
trigger refreshing by pull-to-refresh gesture.
Rotate device Screen

You should notice the Pull to Refresh indicator disappears even though state.endRefresh() hasn't been called yet. So, the indicator should remain visible on

Stack trace (if applicable): N/A

Attached video showing the bug:

untitled.webm

852 KB

Download

Comments

ma...@google.com <ma...@google.com> Dec 27, 2023 09:39PM

Reassigned to ma...@google.com.

ma...@google.com <ma...@google.com> Apr 4, 2024 10:38PM

Reassigned to ma...@google.com.

ma...@google.com <ma...@google.com> Apr 11, 2024 06:34PM

Accepted by ma...@google.com.

ap...@google.com <ap...@google.com> #2Apr 18, 2024 06:28PM

Marked as fixed.

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

commit a1154475dd101bcf9867c11ceb567f9511dc7c1c
Author: Mariano Martin <marianomartin@google.com>
Date: Fri Apr 05 12:00:06 2024

[PullToRefresh] Update Material 3 PullToRefresh APIs

Test: updated existing tests

Fixes: 314496282, 317177684, 323787138, 324573502, 317177683

Relnote: "New pull-to-refresh APIs:

- Simplified PullToRefreshState to use fractional values instead of Dp units.
- isRefreshing state is controlled by the user instead of PullToRefreshState.
- Separated out the nested scroll connection from PullToRefreshState. It is handled by the new PullToRefreshBox or Modifier.pullToRefresh.

- This update is a breaking change to previous experimental APIs."

Change-Id: I0adeb950063988d1a05aca7aa135ccd982431423

M compose/material3/material3/api/current.txt
M compose/material3/material3/api/restricted_current.txt
M compose/material3/material3/integration-tests/material3-catalog/src/main/java/androidx/compose/material3/catalog/library/model/Examples.kt
M compose/material3/material3/integration-tests/material3-demos/src/main/java/androidx/compose/material3/demos/PullToRefreshDemo.kt
M compose/material3/material3/samples/src/main/java/androidx/compose/material3/samples/PullToRefreshSamples.kt
M compose/material3/material3/src/androidInstrumentedTest/kotlin/androidx/compose/material3/pulltorefresh/PullToRefreshIndicatorScreenshotTest.kt
M compose/material3/material3/src/androidInstrumentedTest/kotlin/androidx/compose/material3/pulltorefresh/PullToRefreshIndicatorTest.kt
M compose/material3/material3/src/androidInstrumentedTest/kotlin/androidx/compose/material3/pulltorefresh/PullToRefreshStateImplTest.kt
M compose/material3/material3/src/commonMain/kotlin/androidx/compose/material3/pulltorefresh/PullToRefresh.kt

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

Issue 317177684

Description

Issue summary

Comments

ma...@google.com <ma...@google.com> Dec 27, 2023 09:39PM

ma...@google.com <ma...@google.com> Apr 4, 2024 10:38PM

ma...@google.com <ma...@google.com> Apr 11, 2024 06:34PM

ap...@google.com <ap...@google.com> #2Apr 18, 2024 06:28PM

Add comment

Issue metadata