androidx.wear.compose.navigation3

Classes

SwipeDismissableSceneStrategy

A SceneStrategy that displays entries within a Wear Material component.
SwipeDismissableSceneStrategyState

State for SwipeDismissableSceneStrategy

Top-level functions summary

SwipeDismissableSceneStrategy<T>
@Composable
<T : Any> rememberSwipeDismissableSceneStrategy(
    swipeDismissableSceneStrategyState: SwipeDismissableSceneStrategyState,
    modifier: Modifier,
    isUserSwipeEnabled: Boolean
)

Creates and remembers a SwipeDismissableSceneStrategy.
SwipeDismissableSceneStrategyState

Remembers and returns a SwipeDismissableSceneStrategyState

Top-level functions

rememberSwipeDismissableSceneStrategy

@Composable
fun <T : Any> rememberSwipeDismissableSceneStrategy(
    swipeDismissableSceneStrategyState: SwipeDismissableSceneStrategyState = rememberSwipeDismissableSceneStrategyState(),
    modifier: Modifier = Modifier,
    isUserSwipeEnabled: Boolean = true
): SwipeDismissableSceneStrategy<T>

Creates and remembers a SwipeDismissableSceneStrategy.

Parameters
<T : Any>

the KType of the backstack key
swipeDismissableSceneStrategyState: SwipeDismissableSceneStrategyState = rememberSwipeDismissableSceneStrategyState()

State containing information about ongoing swipe and animation. This parameter is unused API level 36 onwards, because the platform supports predictive back and SwipeDismissableSceneStrategy uses platform gestures to detect the back gestures.
modifier: Modifier = Modifier

The modifier to be applied to the layout
isUserSwipeEnabled: Boolean = true

Boolean Whether swipe-to-dismiss gesture is enabled.

rememberSwipeDismissableSceneStrategyState

@Composable
fun rememberSwipeDismissableSceneStrategyState(
    swipeToDismissBoxState: SwipeToDismissBoxState? = if (Build.VERSION.SDK_INT <= 35) rememberSwipeToDismissBoxState() else null
): SwipeDismissableSceneStrategyState

Remembers and returns a SwipeDismissableSceneStrategyState

Parameters
swipeToDismissBoxState: SwipeToDismissBoxState? = if (Build.VERSION.SDK_INT <= 35) rememberSwipeToDismissBoxState() else null

State for BasicSwipeToDismissBox, which is used to support the swipe-to-dismiss gesture in SwipeDismissableSceneStrategy for devices running API 35 or under. Defaults to null for devices running API 36+.