androidx.navigation.compose

Classes

ComposeNavigator	Navigator that navigates through Composables.
ComposeNavigator.Destination	NavDestination specific to ComposeNavigator
ComposeNavigatorDestinationBuilder	DSL for constructing a new ComposeNavigator.Destination
DialogNavigator	Navigator that navigates through Composables that will be hosted within a Dialog.
DialogNavigator.Destination	NavDestination specific to DialogNavigator
DialogNavigatorDestinationBuilder	DSL for constructing a new DialogNavigator.Destination

Top-level functions summary

Unit	@Composable DialogHost(dialogNavigator: DialogNavigator) Show each Destination on the DialogNavigator's back stack as a Dialog.
Unit	@Composable NavHost(     navController: NavHostController,     graph: NavGraph,     modifier: Modifier,     contentAlignment: Alignment,     enterTransition: AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition,     exitTransition: AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition,     popEnterTransition: AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition,     popExitTransition: AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition,     sizeTransform: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> SizeTransform?)? ) Provides a place in the Compose hierarchy for self contained navigation to occur.
Unit	@Composable NavHost(     navController: NavHostController,     startDestination: String,     modifier: Modifier,     contentAlignment: Alignment,     route: String?,     enterTransition: AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition,     exitTransition: AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition,     popEnterTransition: AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition,     popExitTransition: AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition,     sizeTransform: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> SizeTransform?)?,     builder: NavGraphBuilder.() -> Unit ) Provides a place in the Compose hierarchy for self contained navigation to occur.
Unit	@Composable NavHost(     navController: NavHostController,     startDestination: Any,     modifier: Modifier,     contentAlignment: Alignment,     route: KClass<*>?,     typeMap: Map<KType, NavType<*>>,     enterTransition: AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition,     exitTransition: AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition,     popEnterTransition: AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition,     popExitTransition: AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition,     sizeTransform: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> SizeTransform?)?,     builder: NavGraphBuilder.() -> Unit ) Provides in place in the Compose hierarchy for self contained navigation to occur.
Unit	@Composable NavHost(     navController: NavHostController,     startDestination: KClass<*>,     modifier: Modifier,     contentAlignment: Alignment,     route: KClass<*>?,     typeMap: Map<KType, NavType<*>>,     enterTransition: AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition,     exitTransition: AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition,     popEnterTransition: AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition,     popExitTransition: AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition,     sizeTransform: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> SizeTransform?)?,     builder: NavGraphBuilder.() -> Unit ) Provides a place in the Compose hierarchy for self contained navigation to occur.
NavHostController	@Composable rememberNavController(vararg navigators: Navigator<NavDestination>) Creates a NavHostController that handles the adding of the ComposeNavigator and DialogNavigator.

Extension functions summary

Unit	@Composable NavBackStackEntry.LocalOwnersProvider(     saveableStateHolder: SaveableStateHolder,     content: @Composable () -> Unit ) Provides this as LocalViewModelStoreOwner, LocalLifecycleOwner and LocalSavedStateRegistryOwner to the content and saves the content's saveable states with the given saveableStateHolder.
inline Unit	<T : Any> NavGraphBuilder.composable(     typeMap: Map<KType, NavType<*>>,     deepLinks: List<NavDeepLink>,     noinline enterTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition?)?,     noinline exitTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition?)?,     noinline popEnterTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition?)?,     noinline popExitTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition?)?,     noinline sizeTransform: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> SizeTransform?)?,     noinline content: @Composable AnimatedContentScope.(NavBackStackEntry) -> Unit ) Add the Composable to the NavGraphBuilder
Unit	NavGraphBuilder.composable(     route: String,     arguments: List<NamedNavArgument>,     deepLinks: List<NavDeepLink>,     enterTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition?)?,     exitTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition?)?,     popEnterTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition?)?,     popExitTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition?)?,     sizeTransform: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> SizeTransform?)?,     content: @Composable AnimatedContentScope.(NavBackStackEntry) -> Unit ) Add the Composable to the NavGraphBuilder
State<NavBackStackEntry?>	@Composable NavController.currentBackStackEntryAsState() Gets the current navigation back stack entry as a MutableState.
inline Unit	<T : Any> NavGraphBuilder.dialog(     typeMap: Map<KType, NavType<*>>,     deepLinks: List<NavDeepLink>,     dialogProperties: DialogProperties,     noinline content: @Composable (NavBackStackEntry) -> Unit ) Add the Composable to the NavGraphBuilder that will be hosted within a androidx.compose.ui.window.Dialog.
Unit	NavGraphBuilder.dialog(     route: String,     arguments: List<NamedNavArgument>,     deepLinks: List<NavDeepLink>,     dialogProperties: DialogProperties,     content: @Composable (NavBackStackEntry) -> Unit ) Add the Composable to the NavGraphBuilder that will be hosted within a androidx.compose.ui.window.Dialog.
inline Unit	<T : Any> NavGraphBuilder.navigation(     startDestination: Any,     typeMap: Map<KType, NavType<*>>,     deepLinks: List<NavDeepLink>,     noinline enterTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition?)?,     noinline exitTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition?)?,     noinline popEnterTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition?)?,     noinline popExitTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition?)?,     noinline sizeTransform: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> SizeTransform?)?,     noinline builder: NavGraphBuilder.() -> Unit ) Construct a nested NavGraph
inline Unit	<T : Any> NavGraphBuilder.navigation(     startDestination: KClass<*>,     typeMap: Map<KType, NavType<*>>,     deepLinks: List<NavDeepLink>,     noinline enterTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition?)?,     noinline exitTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition?)?,     noinline popEnterTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition?)?,     noinline popExitTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition?)?,     noinline sizeTransform: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> SizeTransform?)?,     noinline builder: NavGraphBuilder.() -> Unit ) Construct a nested NavGraph
Unit	NavGraphBuilder.navigation(     startDestination: String,     route: String,     arguments: List<NamedNavArgument>,     deepLinks: List<NavDeepLink>,     enterTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition?)?,     exitTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition?)?,     popEnterTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition?)?,     popExitTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition?)?,     sizeTransform: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> SizeTransform?)?,     builder: NavGraphBuilder.() -> Unit ) Construct a nested NavGraph

Top-level functions

DialogHost

Artifact: androidx.navigation:navigation-compose

View Source

Added in 2.4.0

@Composable
fun DialogHost(dialogNavigator: DialogNavigator): Unit

Show each Destination on the DialogNavigator's back stack as a Dialog.

Note that NavHost will call this for you; you do not need to call it manually.

NavHost

Artifact: androidx.navigation:navigation-compose

View Source

@Composable
fun NavHost(
    navController: NavHostController,
    graph: NavGraph,
    modifier: Modifier = Modifier,
    contentAlignment: Alignment = Alignment.TopStart,
    enterTransition: AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition = {
            fadeIn(animationSpec = tween(700))
        },
    exitTransition: AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition = {
            fadeOut(animationSpec = tween(700))
        },
    popEnterTransition: AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition = enterTransition,
    popExitTransition: AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition = exitTransition,
    sizeTransform: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> SizeTransform?)? = null
): Unit

Provides a place in the Compose hierarchy for self contained navigation to occur.

Once this is called, any Composable within the given NavGraphBuilder can be navigated to from the provided navController.

Parameters
navController: NavHostController	the navController for this host
graph: NavGraph	the graph for this host
modifier: Modifier = Modifier	The modifier to be applied to the layout.
contentAlignment: Alignment = Alignment.TopStart	The Alignment of the AnimatedContent
enterTransition: AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition = { fadeIn(animationSpec = tween(700)) }	callback to define enter transitions for destination in this host
exitTransition: AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition = { fadeOut(animationSpec = tween(700)) }	callback to define exit transitions for destination in this host
popEnterTransition: AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition = enterTransition	callback to define popEnter transitions for destination in this host
popExitTransition: AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition = exitTransition	callback to define popExit transitions for destination in this host
sizeTransform: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> SizeTransform?)? = null	callback to define the size transform for destinations in this host

NavHost

Artifact: androidx.navigation:navigation-compose

View Source

@Composable
fun NavHost(
    navController: NavHostController,
    startDestination: String,
    modifier: Modifier = Modifier,
    contentAlignment: Alignment = Alignment.TopStart,
    route: String? = null,
    enterTransition: AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition = {
            fadeIn(animationSpec = tween(700))
        },
    exitTransition: AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition = {
            fadeOut(animationSpec = tween(700))
        },
    popEnterTransition: AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition = enterTransition,
    popExitTransition: AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition = exitTransition,
    sizeTransform: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> SizeTransform?)? = null,
    builder: NavGraphBuilder.() -> Unit
): Unit

Provides a place in the Compose hierarchy for self contained navigation to occur.

Once this is called, any Composable within the given NavGraphBuilder can be navigated to from the provided navController.

The builder passed into this method is remembered. This means that for this NavHost, the contents of the builder cannot be changed.

Parameters
navController: NavHostController	the navController for this host
startDestination: String	the route for the start destination
modifier: Modifier = Modifier	The modifier to be applied to the layout.
contentAlignment: Alignment = Alignment.TopStart	The Alignment of the AnimatedContent
route: String? = null	the route for the graph
enterTransition: AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition = { fadeIn(animationSpec = tween(700)) }	callback to define enter transitions for destination in this host
exitTransition: AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition = { fadeOut(animationSpec = tween(700)) }	callback to define exit transitions for destination in this host
popEnterTransition: AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition = enterTransition	callback to define popEnter transitions for destination in this host
popExitTransition: AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition = exitTransition	callback to define popExit transitions for destination in this host
sizeTransform: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> SizeTransform?)? = null	callback to define the size transform for destinations in this host
builder: NavGraphBuilder.() -> Unit	the builder used to construct the graph

NavHost

Artifact: androidx.navigation:navigation-compose

View Source

@Composable
fun NavHost(
    navController: NavHostController,
    startDestination: Any,
    modifier: Modifier = Modifier,
    contentAlignment: Alignment = Alignment.TopStart,
    route: KClass<*>? = null,
    typeMap: Map<KType, NavType<*>> = emptyMap(),
    enterTransition: AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition = {
            fadeIn(animationSpec = tween(700))
        },
    exitTransition: AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition = {
            fadeOut(animationSpec = tween(700))
        },
    popEnterTransition: AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition = enterTransition,
    popExitTransition: AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition = exitTransition,
    sizeTransform: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> SizeTransform?)? = null,
    builder: NavGraphBuilder.() -> Unit
): Unit

Provides in place in the Compose hierarchy for self contained navigation to occur.

Once this is called, any Composable within the given NavGraphBuilder can be navigated to from the provided navController.

The builder passed into this method is remembered. This means that for this NavHost, the contents of the builder cannot be changed.

Parameters
navController: NavHostController	the navController for this host
startDestination: Any	the route from a an Object for the start destination
modifier: Modifier = Modifier	The modifier to be applied to the layout.
contentAlignment: Alignment = Alignment.TopStart	The Alignment of the AnimatedContent
route: KClass<*>? = null	the route from a KClass for the graph
typeMap: Map<KType, NavType<*>> = emptyMap()	map of destination arguments' kotlin type KType to its respective custom NavType. May be empty if route does not use custom NavTypes.
enterTransition: AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition = { fadeIn(animationSpec = tween(700)) }	callback to define enter transitions for destination in this host
exitTransition: AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition = { fadeOut(animationSpec = tween(700)) }	callback to define exit transitions for destination in this host
popEnterTransition: AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition = enterTransition	callback to define popEnter transitions for destination in this host
popExitTransition: AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition = exitTransition	callback to define popExit transitions for destination in this host
sizeTransform: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> SizeTransform?)? = null	callback to define the size transform for destinations in this host
builder: NavGraphBuilder.() -> Unit	the builder used to construct the graph

NavHost

Artifact: androidx.navigation:navigation-compose

View Source

@Composable
fun NavHost(
    navController: NavHostController,
    startDestination: KClass<*>,
    modifier: Modifier = Modifier,
    contentAlignment: Alignment = Alignment.TopStart,
    route: KClass<*>? = null,
    typeMap: Map<KType, NavType<*>> = emptyMap(),
    enterTransition: AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition = {
            fadeIn(animationSpec = tween(700))
        },
    exitTransition: AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition = {
            fadeOut(animationSpec = tween(700))
        },
    popEnterTransition: AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition = enterTransition,
    popExitTransition: AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition = exitTransition,
    sizeTransform: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> SizeTransform?)? = null,
    builder: NavGraphBuilder.() -> Unit
): Unit

Provides a place in the Compose hierarchy for self contained navigation to occur.

Once this is called, any Composable within the given NavGraphBuilder can be navigated to from the provided navController.

The builder passed into this method is remembered. This means that for this NavHost, the contents of the builder cannot be changed.

Parameters
navController: NavHostController	the navController for this host
startDestination: KClass<*>	the route from a KClass for the start destination
modifier: Modifier = Modifier	The modifier to be applied to the layout.
contentAlignment: Alignment = Alignment.TopStart	The Alignment of the AnimatedContent
route: KClass<*>? = null	the route from a KClass for the graph
typeMap: Map<KType, NavType<*>> = emptyMap()	map of destination arguments' kotlin type KType to its respective custom NavType. May be empty if route does not use custom NavTypes.
enterTransition: AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition = { fadeIn(animationSpec = tween(700)) }	callback to define enter transitions for destination in this host
exitTransition: AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition = { fadeOut(animationSpec = tween(700)) }	callback to define exit transitions for destination in this host
popEnterTransition: AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition = enterTransition	callback to define popEnter transitions for destination in this host
popExitTransition: AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition = exitTransition	callback to define popExit transitions for destination in this host
sizeTransform: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> SizeTransform?)? = null	callback to define the size transform for destinations in this host
builder: NavGraphBuilder.() -> Unit	the builder used to construct the graph

rememberNavController

Artifact: androidx.navigation:navigation-compose

View Source

Added in 2.4.0

@Composable
fun rememberNavController(vararg navigators: Navigator<NavDestination>): NavHostController

Creates a NavHostController that handles the adding of the ComposeNavigator and DialogNavigator. Additional Navigator instances can be passed through navigators to be applied to the returned NavController. Note that each Navigator must be separately remembered before being passed in here: any changes to those inputs will cause the NavController to be recreated.

See also
NavHost

Extension functions

LocalOwnersProvider

Artifact: androidx.navigation:navigation-compose

View Source

Added in 2.4.0

@Composable
fun NavBackStackEntry.LocalOwnersProvider(
    saveableStateHolder: SaveableStateHolder,
    content: @Composable () -> Unit
): Unit

Provides this as LocalViewModelStoreOwner, LocalLifecycleOwner and LocalSavedStateRegistryOwner to the content and saves the content's saveable states with the given saveableStateHolder.

Parameters
saveableStateHolder: SaveableStateHolder	The SaveableStateHolder that holds the saved states. The same holder should be used for all NavBackStackEntrys in the encapsulating Composable and the holder should be hoisted.
content: @Composable () -> Unit	The content Composable

composable

Artifact: androidx.navigation:navigation-compose

View Source

inline fun <T : Any> NavGraphBuilder.composable(
    typeMap: Map<KType, NavType<*>> = emptyMap(),
    deepLinks: List<NavDeepLink> = emptyList(),
    noinline enterTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition?)? = null,
    noinline exitTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition?)? = null,
    noinline popEnterTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition?)? = enterTransition,
    noinline popExitTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition?)? = exitTransition,
    noinline sizeTransform: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> SizeTransform?)? = null,
    noinline content: @Composable AnimatedContentScope.(NavBackStackEntry) -> Unit
): Unit

Add the Composable to the NavGraphBuilder

Parameters
<T : Any>	route from a KClass for the destination
typeMap: Map<KType, NavType<*>> = emptyMap()	map of destination arguments' kotlin type KType to its respective custom NavType. May be empty if T does not use custom NavTypes.
deepLinks: List<NavDeepLink> = emptyList()	list of deep links to associate with the destinations
noinline enterTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition?)? = null	callback to determine the destination's enter transition
noinline exitTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition?)? = null	callback to determine the destination's exit transition
noinline popEnterTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition?)? = enterTransition	callback to determine the destination's popEnter transition
noinline popExitTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition?)? = exitTransition	callback to determine the destination's popExit transition
noinline sizeTransform: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> SizeTransform?)? = null	callback to determine the destination's sizeTransform.
noinline content: @Composable AnimatedContentScope.(NavBackStackEntry) -> Unit	composable for the destination

composable

Artifact: androidx.navigation:navigation-compose

View Source

fun NavGraphBuilder.composable(
    route: String,
    arguments: List<NamedNavArgument> = emptyList(),
    deepLinks: List<NavDeepLink> = emptyList(),
    enterTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition?)? = null,
    exitTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition?)? = null,
    popEnterTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition?)? = enterTransition,
    popExitTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition?)? = exitTransition,
    sizeTransform: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> SizeTransform?)? = null,
    content: @Composable AnimatedContentScope.(NavBackStackEntry) -> Unit
): Unit

Add the Composable to the NavGraphBuilder

Parameters
route: String	route for the destination
arguments: List<NamedNavArgument> = emptyList()	list of arguments to associate with destination
deepLinks: List<NavDeepLink> = emptyList()	list of deep links to associate with the destinations
enterTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition?)? = null	callback to determine the destination's enter transition
exitTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition?)? = null	callback to determine the destination's exit transition
popEnterTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition?)? = enterTransition	callback to determine the destination's popEnter transition
popExitTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition?)? = exitTransition	callback to determine the destination's popExit transition
sizeTransform: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> SizeTransform?)? = null	callback to determine the destination's sizeTransform.
content: @Composable AnimatedContentScope.(NavBackStackEntry) -> Unit	composable for the destination

currentBackStackEntryAsState

Artifact: androidx.navigation:navigation-compose

View Source

Added in 2.4.0

@Composable
fun NavController.currentBackStackEntryAsState(): State<NavBackStackEntry?>

Gets the current navigation back stack entry as a MutableState. When the given navController changes the back stack due to a NavController.navigate or NavController.popBackStack this will trigger a recompose and return the top entry on the back stack.

Returns
State<NavBackStackEntry?>	a mutable state of the current back stack entry

dialog

Artifact: androidx.navigation:navigation-compose

View Source

inline fun <T : Any> NavGraphBuilder.dialog(
    typeMap: Map<KType, NavType<*>> = emptyMap(),
    deepLinks: List<NavDeepLink> = emptyList(),
    dialogProperties: DialogProperties = DialogProperties(),
    noinline content: @Composable (NavBackStackEntry) -> Unit
): Unit

Add the Composable to the NavGraphBuilder that will be hosted within a androidx.compose.ui.window.Dialog. This is suitable only when this dialog represents a separate screen in your app that needs its own lifecycle and saved state, independent of any other destination in your navigation graph. For use cases such as AlertDialog, you should use those APIs directly in the composable destination that wants to show that dialog.

Parameters
<T : Any>	route from a KClass for the destination
typeMap: Map<KType, NavType<*>> = emptyMap()	map of destination arguments' kotlin type KType to its respective custom NavType. May be empty if T does not use custom NavTypes.
deepLinks: List<NavDeepLink> = emptyList()	list of deep links to associate with the destinations
dialogProperties: DialogProperties = DialogProperties()	properties that should be passed to androidx.compose.ui.window.Dialog.
noinline content: @Composable (NavBackStackEntry) -> Unit	composable content for the destination that will be hosted within the Dialog

dialog

Artifact: androidx.navigation:navigation-compose

View Source

Added in 2.4.0

fun NavGraphBuilder.dialog(
    route: String,
    arguments: List<NamedNavArgument> = emptyList(),
    deepLinks: List<NavDeepLink> = emptyList(),
    dialogProperties: DialogProperties = DialogProperties(),
    content: @Composable (NavBackStackEntry) -> Unit
): Unit

Add the Composable to the NavGraphBuilder that will be hosted within a androidx.compose.ui.window.Dialog. This is suitable only when this dialog represents a separate screen in your app that needs its own lifecycle and saved state, independent of any other destination in your navigation graph. For use cases such as AlertDialog, you should use those APIs directly in the composable destination that wants to show that dialog.

Parameters
route: String	route for the destination
arguments: List<NamedNavArgument> = emptyList()	list of arguments to associate with destination
deepLinks: List<NavDeepLink> = emptyList()	list of deep links to associate with the destinations
dialogProperties: DialogProperties = DialogProperties()	properties that should be passed to androidx.compose.ui.window.Dialog.
content: @Composable (NavBackStackEntry) -> Unit	composable content for the destination that will be hosted within the Dialog

navigation

Artifact: androidx.navigation:navigation-compose

View Source

inline fun <T : Any> NavGraphBuilder.navigation(
    startDestination: Any,
    typeMap: Map<KType, NavType<*>> = emptyMap(),
    deepLinks: List<NavDeepLink> = emptyList(),
    noinline enterTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition?)? = null,
    noinline exitTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition?)? = null,
    noinline popEnterTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition?)? = enterTransition,
    noinline popExitTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition?)? = exitTransition,
    noinline sizeTransform: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> SizeTransform?)? = null,
    noinline builder: NavGraphBuilder.() -> Unit
): Unit

Construct a nested NavGraph

import androidx.compose.animation.EnterTransition
import androidx.compose.animation.ExitTransition
import androidx.compose.animation.SizeTransform
import androidx.compose.animation.core.keyframes
import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.size
import androidx.compose.ui.unit.IntSize
import androidx.navigation.compose.NavHost
import androidx.navigation.compose.composable
import androidx.navigation.compose.rememberNavController

val navController = rememberNavController()
Box {
    NavHost(navController, startDestination = Collapsed) {
        composable<Collapsed>(
            enterTransition = { EnterTransition.None },
            exitTransition = { ExitTransition.None },
            sizeTransform = {
                SizeTransform { initialSize, targetSize ->
                    keyframes {
                        durationMillis = 500
                        IntSize(
                            initialSize.width,
                            (initialSize.height + targetSize.height) / 2
                        ) at 150
                    }
                }
            }
        ) {
            CollapsedScreen { navController.navigate(Expanded) }
        }
        composable<Expanded>(
            enterTransition = { EnterTransition.None },
            exitTransition = { ExitTransition.None },
            sizeTransform = {
                SizeTransform { initialSize, targetSize ->
                    keyframes {
                        durationMillis = 500
                        IntSize(targetSize.width, initialSize.height + 400) at 150
                    }
                }
            }
        ) {
            ExpandedScreen { navController.popBackStack() }
        }
    }
}

Parameters
<T : Any>	the destination's unique route from a KClass
startDestination: Any	the starting destination's route from an Object for this NavGraph
typeMap: Map<KType, NavType<*>> = emptyMap()	map of destination arguments' kotlin type KType to its respective custom NavType. May be empty if T does not use custom NavTypes.
deepLinks: List<NavDeepLink> = emptyList()	list of deep links to associate with the destinations
noinline enterTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition?)? = null	callback to define enter transitions for destination in this NavGraph
noinline exitTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition?)? = null	callback to define exit transitions for destination in this NavGraph
noinline popEnterTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition?)? = enterTransition	callback to define pop enter transitions for destination in this NavGraph
noinline popExitTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition?)? = exitTransition	callback to define pop exit transitions for destination in this NavGraph
noinline sizeTransform: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> SizeTransform?)? = null	callback to define the size transform for destinations in this NavGraph
noinline builder: NavGraphBuilder.() -> Unit	the builder used to construct the graph

Returns
Unit	the newly constructed nested NavGraph

navigation

Artifact: androidx.navigation:navigation-compose

View Source

inline fun <T : Any> NavGraphBuilder.navigation(
    startDestination: KClass<*>,
    typeMap: Map<KType, NavType<*>> = emptyMap(),
    deepLinks: List<NavDeepLink> = emptyList(),
    noinline enterTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition?)? = null,
    noinline exitTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition?)? = null,
    noinline popEnterTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition?)? = enterTransition,
    noinline popExitTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition?)? = exitTransition,
    noinline sizeTransform: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> SizeTransform?)? = null,
    noinline builder: NavGraphBuilder.() -> Unit
): Unit

Construct a nested NavGraph

import androidx.compose.animation.EnterTransition
import androidx.compose.animation.ExitTransition
import androidx.compose.animation.SizeTransform
import androidx.compose.animation.core.keyframes
import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.size
import androidx.compose.ui.unit.IntSize
import androidx.navigation.compose.NavHost
import androidx.navigation.compose.composable
import androidx.navigation.compose.rememberNavController

val navController = rememberNavController()
Box {
    NavHost(navController, startDestination = Collapsed) {
        composable<Collapsed>(
            enterTransition = { EnterTransition.None },
            exitTransition = { ExitTransition.None },
            sizeTransform = {
                SizeTransform { initialSize, targetSize ->
                    keyframes {
                        durationMillis = 500
                        IntSize(
                            initialSize.width,
                            (initialSize.height + targetSize.height) / 2
                        ) at 150
                    }
                }
            }
        ) {
            CollapsedScreen { navController.navigate(Expanded) }
        }
        composable<Expanded>(
            enterTransition = { EnterTransition.None },
            exitTransition = { ExitTransition.None },
            sizeTransform = {
                SizeTransform { initialSize, targetSize ->
                    keyframes {
                        durationMillis = 500
                        IntSize(targetSize.width, initialSize.height + 400) at 150
                    }
                }
            }
        ) {
            ExpandedScreen { navController.popBackStack() }
        }
    }
}

Parameters
<T : Any>	the destination's unique route from a KClass
startDestination: KClass<*>	the starting destination's route from KClass for this NavGraph
typeMap: Map<KType, NavType<*>> = emptyMap()	map of destination arguments' kotlin type KType to its respective custom NavType. May be empty if T does not use custom NavTypes.
deepLinks: List<NavDeepLink> = emptyList()	list of deep links to associate with the destinations
noinline enterTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition?)? = null	callback to define enter transitions for destination in this NavGraph
noinline exitTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition?)? = null	callback to define exit transitions for destination in this NavGraph
noinline popEnterTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition?)? = enterTransition	callback to define pop enter transitions for destination in this NavGraph
noinline popExitTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition?)? = exitTransition	callback to define pop exit transitions for destination in this NavGraph
noinline sizeTransform: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> SizeTransform?)? = null	callback to define the size transform for destinations in this NavGraph
noinline builder: NavGraphBuilder.() -> Unit	the builder used to construct the graph

Returns
Unit	the newly constructed nested NavGraph

navigation

Artifact: androidx.navigation:navigation-compose

View Source

fun NavGraphBuilder.navigation(
    startDestination: String,
    route: String,
    arguments: List<NamedNavArgument> = emptyList(),
    deepLinks: List<NavDeepLink> = emptyList(),
    enterTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition?)? = null,
    exitTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition?)? = null,
    popEnterTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition?)? = enterTransition,
    popExitTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition?)? = exitTransition,
    sizeTransform: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> SizeTransform?)? = null,
    builder: NavGraphBuilder.() -> Unit
): Unit

Construct a nested NavGraph

import androidx.compose.animation.EnterTransition
import androidx.compose.animation.ExitTransition
import androidx.compose.animation.SizeTransform
import androidx.compose.animation.core.keyframes
import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.size
import androidx.compose.ui.unit.IntSize
import androidx.navigation.compose.NavHost
import androidx.navigation.compose.composable
import androidx.navigation.compose.rememberNavController

val navController = rememberNavController()
Box {
    NavHost(navController, startDestination = Collapsed) {
        composable<Collapsed>(
            enterTransition = { EnterTransition.None },
            exitTransition = { ExitTransition.None },
            sizeTransform = {
                SizeTransform { initialSize, targetSize ->
                    keyframes {
                        durationMillis = 500
                        IntSize(
                            initialSize.width,
                            (initialSize.height + targetSize.height) / 2
                        ) at 150
                    }
                }
            }
        ) {
            CollapsedScreen { navController.navigate(Expanded) }
        }
        composable<Expanded>(
            enterTransition = { EnterTransition.None },
            exitTransition = { ExitTransition.None },
            sizeTransform = {
                SizeTransform { initialSize, targetSize ->
                    keyframes {
                        durationMillis = 500
                        IntSize(targetSize.width, initialSize.height + 400) at 150
                    }
                }
            }
        ) {
            ExpandedScreen { navController.popBackStack() }
        }
    }
}

Parameters
startDestination: String	the starting destination's route for this NavGraph
route: String	the destination's unique route
arguments: List<NamedNavArgument> = emptyList()	list of arguments to associate with destination
deepLinks: List<NavDeepLink> = emptyList()	list of deep links to associate with the destinations
enterTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition?)? = null	callback to define enter transitions for destination in this NavGraph
exitTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition?)? = null	callback to define exit transitions for destination in this NavGraph
popEnterTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition?)? = enterTransition	callback to define pop enter transitions for destination in this NavGraph
popExitTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition?)? = exitTransition	callback to define pop exit transitions for destination in this NavGraph
sizeTransform: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> SizeTransform?)? = null	callback to define the size transform for destinations in this NavGraph
builder: NavGraphBuilder.() -> Unit	the builder used to construct the graph

Returns
Unit	the newly constructed nested NavGraph