mosaic-client/dev.catbit.mosaic.client.ui.sdui.foundation.navigation/NavigationController

NavigationController

class NavigationController(val backStack: NavBackStack<ScreenNavKey>)

Thin wrapper over one Navigation3 NavBackStack — the object registered in NavigatorsHolder under a navigatorId, and what Navigate/NavigateUp/NavigateClearingStack actually operate on. One instance per backstack — the app's own root one (built in MosaicApplication) and one per currently-composed NestedNavigationGraph tile.

Constructors

constructor(backStack: NavBackStack<ScreenNavKey>)

Properties

backStack

val backStack: NavBackStack<ScreenNavKey>

the underlying Navigation3 back stack this controller wraps.

Functions

goBack

fun goBack()

Pops the last entry off this backstack, if any — the mechanism behind NavigateUp. A no-op if the stack is already empty.

navigate

fun navigate(destination: String, navigationData: Map<String, AnySerializable>? = null, poppingUpTo: PopUpTo? = null, launchSingleTop: Boolean = true)

Pushes destination onto this backstack — the mechanism behind Navigate.

navigateClearingStack

fun navigateClearingStack(destination: String, navigationData: Map<String, AnySerializable>? = null, launchSingleTop: Boolean = true)

Clears this backstack entirely and pushes destination as its only entry — the mechanism behind NavigateClearingStack.