NavCommand

sealed interface NavCommand(source)

Immutable state-mutation command accepted by NavBackStackController.prepare.

Types

data class OpenDeepLink(val route: NavRoute, val targetStackId: NavStackId? = null, val launchMode: NavDeepLinkLaunchMode = NavDeepLinkLaunchMode.Reset) : NavCommand

Mutates a destination stack and selects it as one atomic transaction.

data object Pop : NavCommand

Removes the active stack's top entry when it is not the root.

Returns to the newest stack in selection history without adding the current stack back.

data class Push(val route: NavRoute, val launchMode: NavLaunchMode = NavLaunchMode.Standard) : NavCommand

Appends a resolved destination to the active stack.

Replaces the active top while retaining entries beneath it.

data class Reset(val route: NavRoute) : NavCommand

Replaces the complete active stack with one newly allocated root entry.

data class SelectStack(val stackId: NavStackId, val selectionMode: NavStackSelectionMode = NavStackSelectionMode.Preserve) : NavCommand

Selects an independently retained stack.