khonshu-navigation-core/com.hoc081098.solivagant.navigation/NavEventNavigator

NavEventNavigator

open class NavEventNavigator : Navigator, ResultNavigator, BackInterceptor(source)

This allows to trigger navigation actions from outside the view layer without keeping references to Android framework classes that might leak. It also improves the testability of your navigation logic since it is possible to just write test that the correct events were emitted.

Constructors

NavEventNavigator

constructor()

Properties

navEvents

@InternalNavigationApi

val navEvents: Flow<NavEvent>

navigationResultRequests

@InternalNavigationApi

val navigationResultRequests: List<NavigationResultRequest<*>>

onBackPressedCallback

@InternalNavigationApi

val onBackPressedCallback: OnBackPressedCallback

Functions

backPresses

open override fun backPresses(): Flow<Unit>

Returns a Flow that will emit Unit on every back press. While this Flow is being collected all back presses will be intercepted and none of the default back press handling happens.

open override fun <T> backPresses(value: T): Flow<T>

Returns a Flow that will emit value on every back press. While this Flow is being collected all back presses will be intercepted and none of the default back press handling happens.

deliverNavigationResult

open override fun <O : Parcelable> deliverNavigationResult(key: NavigationResultRequest.Key<O>, result: O)

Delivers the result to the destination that created key.

navigate

fun navigate(block: Navigator.() -> Unit)

Triggers a new NavEvent that collects and combines the nav events sent in the block so they can be handled individually.

navigateBack

open override fun navigateBack()

Triggers a new NavEvent that pops the back stack to the previous destination.

navigateBackTo

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.

navigateBackToInternal

@InternalNavigationApi

open override fun <T : BaseRoute> navigateBackToInternal(popUpTo: DestinationId<T>, inclusive: Boolean)

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

navigateTo

open override fun navigateTo(route: NavRoute)

Triggers a new NavEvent to navigate to the given route.

navigateToRoot

open override fun navigateToRoot(root: NavRoot, restoreRootState: Boolean)

Triggers a new NavEvent to navigate to the given root. The current back stack will be popped and saved. Whether the backstack of the given root is restored depends on restoreRootState.

navigateUp

open override fun navigateUp()

Triggers a new NavEvent that causes up navigation.

replaceAll

open override fun replaceAll(root: NavRoot)

Replace the current back stack with the given root. The current back stack will cleared and the given root will be recreated. After this call the back stack will only contain the given root.

resetToRoot

open override fun resetToRoot(root: NavRoot)

Reset the back stack to the given root. The current back stack will cleared and if root was already on it it will be recreated.