navigator-compose/com.kpstv.navigation.compose/ComposeNavigator

ComposeNavigator

class ComposeNavigator

A navigator for managing pure composable navigation in Jetpack Compose.

Types

object Companion

class Controller<T : Route>

A controller to manage navigation for Route T.

class DialogScope<T : DialogRoute>

DialogScope provides functions that are convenient and only applicable in the context of Controller.CreateDialog such as dismiss, dialogRoute& a dialogNavigator.

Functions

fun canGoBack(): Boolean

Recursive reverse calls to History.canGoBack from backStackMap to identify if back navigation is possible or not.

fun getAllHistory(): List<Route>

fun getAllKeys(): List<RouteKey<out Route>>

fun getHistory(key: RouteKey<out Route>): List<Route>

fun goBack(): Route?

Recursive reverse call to History.canGoBack to identify if back navigation is possible or not.

fun goBackToRoot(): Boolean

Jump back to the root destination of the leaf navigation.

fun goBackUntil(destKey: KClass<out Route>, inclusive: Boolean = false): Boolean

Go back call until destination is satisfied. It also considers destination from parent navigation.

onSaveInstanceState

fun onSaveInstanceState(outState: Bundle)

Save all the ComposeNavigator's internal states along with destination states.

@Composable

fun <T : Route> Setup(modifier: Modifier = Modifier, key: RouteKey<T>, initial: T, controller: ComposeNavigator.Controller<T>, content: @Composable (T) -> Unit)

An entry to setup navigation.