navigation/com.freeletics.khonshu.navigation/Navigator

Navigator

interface Navigator

Inheritors

DestinationNavigator

Types

object Companion

Functions

deliverNavigationResult

inline fun <O> Navigator.deliverNavigationResult(key: NavigationResultRequest.Key<O>, result: O)

Delivers the result to the destination that created key.

abstract fun getEntryFor(id: StackEntry.Id): StackEntry<*>

abstract fun getTopEntryFor(destinationId: DestinationId<*>): StackEntry<*>

abstract fun navigateBack()

Removes the top entry from the backstack to show the previous destination.

abstract fun <T : BaseRoute> navigateBackTo(popUpTo: KClass<T>, inclusive: Boolean = false)

Removes all entries from the backstack until T. If inclusive is true T itself will also be removed.

inline fun <T : NavRoute> Navigator.navigateBackTo(inclusive: Boolean = false)

Removes all entries from the backstack until T. If inclusive is true T itself will also be removed.

abstract fun navigateTo(route: NavRoute)

Triggers navigation to the given route.

abstract fun navigateUp()

Triggers up navigation.

registerForNavigationResult

inline fun <T : BaseRoute, O : Any> Navigator.registerForNavigationResult(): NavigationResultRequest<O>

Register for receiving navigation results.

replaceAllBackStacks

abstract fun replaceAllBackStacks(root: NavRoot)

Remove all back stacks and create a new back stack with the given root.

abstract fun showRoot(root: NavRoot)

Show root as the current destination. If there already is a back stack for root, regardless of whether it is the current back stack or not, the stack will be cleared.

switchBackStack

abstract fun switchBackStack(root: NavRoot)

Show the existing back stack for root or create a new back stack if none exists. If an existing back stack is shown it will be shown in it's previous state. If root is the root of the current back stack this is a no-op.