rememberSwipeDismissableNavHostState

Functions summary

SwipeDismissableNavHostState

@Composable rememberSwipeDismissableNavHostState(     swipeToDismissBoxState: SwipeToDismissBoxState ) Create a SwipeToDismissBoxState and remember it.

Functions

rememberSwipeDismissableNavHostState

Artifact: androidx.wear.compose:compose-navigation

View Source

Added in 1.4.0

@Composable
fun rememberSwipeDismissableNavHostState(
    swipeToDismissBoxState: SwipeToDismissBoxState = rememberSwipeToDismissBoxState()
): SwipeDismissableNavHostState

Create a SwipeToDismissBoxState and remember it.

Parameters

swipeToDismissBoxState: SwipeToDismissBoxState = rememberSwipeToDismissBoxState()

State for BasicSwipeToDismissBox, which is used to support the swipe-to-dismiss gesture in SwipeDismissableNavHost and can also be used to support edge-swiping, using edgeSwipeToDismiss. This parameter is unused after API 36, because the platform supports edge-swiping via predictive back gesture, and SwipeDismissableNavHost drops the use of BasicSwipeToDismissBox in favour of predictive back based navigation.