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.

NavigationResultRequest

class NavigationResultRequest<R : Parcelable> : ResultOwner<R>

Class that exposes a results that can be used to observe results for the given key.

Navigator

interface Navigator

NavRoot

@Immutable

interface NavRoot : BaseRoute

This is similar to a NavRoute but represents the route to the start destination used in a backstack. When you navigate to a NavRoot the current backstack is saved and removed so that the NavRoot is right on top of the start destination.

NavRoute

@Immutable

interface NavRoute : BaseRoute

Represents the route to a destination.

OverlayDestination

@InternalNavigationApi

class OverlayDestination<T : NavRoute>(val id: DestinationId<T>, val extra: Serializable?, val content: @Composable (route: T, modifier: Modifier) -> Unit) : ContentDestination<T>

ResultNavigator

interface ResultNavigator

ResultOwner

sealed class ResultOwner<R>

A base class for anything that exposes a Flow of results. Results will only be delivered to one collector at a time.

ScreenDestination

@InternalNavigationApi

class ScreenDestination<T : BaseRoute>(val id: DestinationId<T>, val extra: Serializable?, val content: @Composable (T, Modifier) -> Unit) : ContentDestination<T>

Serializable

actual typealias Serializable = <Error class: unknown class>

expect interface Serializable

actual interface Serializable

Properties

EXTRA_ROUTE

@InternalNavigationApi

@Stable

const val EXTRA_ROUTE: String

LocalNavigationExecutor

@InternalNavigationApi

val LocalNavigationExecutor: ProvidableCompositionLocal<NavigationExecutor>

Functions

getArguments

@InternalNavigationApi

fun BaseRoute.getArguments(): SavedStateHandle

NavigationSetup

@Composable

fun NavigationSetup(navigator: NavEventNavigator)

Sets up the NavEventNavigator inside the current composition so that it's events are handled while the composition is active.

OverlayDestination

inline fun <T : NavRoute> OverlayDestination(noinline content: @Composable (route: T, modifier: Modifier) -> Unit): NavDestination

Creates a new NavDestination that is shown on top a ScreenDestination, for example a dialog or bottom sheet. The class of T will be used as a unique identifier. The given content will be shown inside the dialog window when navigating to it by using an instance of T.

@InternalNavigationApi

inline fun <T : NavRoute> OverlayDestination(extra: Serializable, noinline content: @Composable (route: T, modifier: Modifier) -> Unit): NavDestination

requireRoute

fun <T : BaseRoute> SavedStateHandle.requireRoute(): T

ScreenDestination

inline fun <T : BaseRoute> ScreenDestination(noinline content: @Composable (route: T, modifier: Modifier) -> Unit): NavDestination

Creates a new NavDestination that represents a full screen. The class of T will be used as a unique identifier. The given content will be shown when the screen is being navigated to using an instance of T.

@InternalNavigationApi

inline fun <T : BaseRoute> ScreenDestination(extra: Serializable, noinline content: @Composable (route: T, modifier: Modifier) -> Unit): NavDestination