Add overload to SwipeToDismissBox with default implementation of LaunchedEffect for snapTo and onDismiss [226565726]

Fixed

Feature Request

Status Update

No update yet.

Description

st...@google.com

created issue #1

Mar 24, 2022 01:56PM

There is a common usage pattern for SwipeToDismissBox which we can support better with an additional overload:

    LaunchedEffect(state.currentValue) {
        if (state.currentValue == SwipeToDismissValue.Dismissed) {
            state.snapTo(SwipeToDismissValue.Default)
            onDismiss()
        }
    }
    SwipeToDismissBox(
        state = state,
    ) { isBackground ->
      /* Content goes here */
    }

Comments

ap...@google.com <ap...@google.com> #2Mar 24, 2022 04:12PM

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

commit 3431b67e269443760b1a656422791b4fb5fe72bc
Author: stevebower <stevebower@google.com>
Date: Thu Mar 24 14:30:50 2022

Add overload with onDismissed to SwipeToDismissBox

The most common usage of SwipeToDismissBox is to define a LaunchedEffect which snaps the offset back to the default position and makes a call to navigate. Here, we are adding an overload to support that usage directly, rather than providing it in our SimpleSwipeToDismissBox sample.

Test: androidx.wear.compose.integration.demos.test and androidx.wear.compose.material.samples.test
Bug: 226565726

Relnote: "We have added a SwipeToDismissBox overload with an onDismissed parameter to support the common usage of triggering a navigation event when the swipe gesture has completed."
Change-Id: I503534f8d11045c9446e976764134c05e147ea33

M wear/compose/compose-material/src/commonMain/kotlin/androidx/wear/compose/material/SwipeToDismissBox.kt
M wear/compose/compose-material/samples/src/main/java/androidx/wear/compose/material/samples/SwipeToDismissBoxSample.kt
M wear/compose/compose-material/api/current.txt
M wear/compose/compose-material/api/restricted_current.txt
M wear/compose/compose-material/api/public_plus_experimental_current.txt
M wear/compose/compose-material/src/androidAndroidTest/kotlin/androidx/wear/compose/material/SwipeToDismissBoxTest.kt

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

st...@google.com <st...@google.com> Mar 24, 2022 04:12PM

Marked as fixed.

Issue 226565726

Description

Issue summary

Comments

ap...@google.com <ap...@google.com> #2Mar 24, 2022 04:12PM

st...@google.com <st...@google.com> Mar 24, 2022 04:12PM

Add comment

Issue metadata