androidx.compose.material.navigation

Common/All

Classes

BottomSheetNavigator	Navigator that drives a ModalBottomSheetState for use of ModalBottomSheetLayouts with the navigation library.	Cmn
BottomSheetNavigator.Destination	NavDestination specific to BottomSheetNavigator.	Cmn
BottomSheetNavigatorDestinationBuilder	DSL for constructing a new BottomSheetNavigator.Destination	Cmn
BottomSheetNavigatorSheetState	The state of a ModalBottomSheetLayout that the BottomSheetNavigator drives	Cmn

Composables

ModalBottomSheetLayout	Create a ModalBottomSheetLayout displaying content from a BottomSheetNavigator.	Cmn
rememberBottomSheetNavigator	Create and remember a BottomSheetNavigator.	Cmn

Extension functions summary

Unit	NavGraphBuilder.bottomSheet(     route: String,     arguments: List<NamedNavArgument>,     deepLinks: List<NavDeepLink>,     content: @Composable ColumnScope.(backstackEntry: NavBackStackEntry) -> Unit ) Add the content as bottom sheet content to the NavGraphBuilder	Cmn
inline Unit	<T : Any> NavGraphBuilder.bottomSheet(     typeMap: Map<KType, NavType<*>>,     arguments: List<NamedNavArgument>,     deepLinks: List<NavDeepLink>,     noinline content: @Composable ColumnScope.(backstackEntry: NavBackStackEntry) -> Unit ) Add the content as bottom sheet content to the NavGraphBuilder	Cmn

Extension functions

NavGraphBuilder.bottomSheet

Cmn

Artifact: androidx.compose.material:material-navigation

View Source

Added in 1.7.0

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

Add the content as bottom sheet content to the NavGraphBuilder

import androidx.compose.material.Text
import androidx.compose.material.navigation.ModalBottomSheetLayout
import androidx.compose.material.navigation.bottomSheet
import androidx.compose.material.navigation.rememberBottomSheetNavigator
import androidx.navigation.compose.NavHost
import androidx.navigation.compose.composable
import androidx.navigation.compose.rememberNavController

val bottomSheetNavigator = rememberBottomSheetNavigator()
val navController = rememberNavController(bottomSheetNavigator)

ModalBottomSheetLayout(bottomSheetNavigator) {
    NavHost(navController, Destinations.Home) {
        composable(Destinations.Home) {
            HomeScreen(
                showSheet = {
                    navController.navigate(Destinations.Sheet + "?arg=From Home Screen")
                },
                showFeed = { navController.navigate(Destinations.Feed) },
            )
        }
        composable(Destinations.Feed) { Text("Feed!") }
        bottomSheet(Destinations.Sheet + "?arg={arg}") { backstackEntry ->
            val arg = backstackEntry.arguments?.getString("arg") ?: "Missing argument :("
            BottomSheet(
                showFeed = { navController.navigate(Destinations.Feed) },
                showAnotherSheet = {
                    navController.navigate(Destinations.Sheet + "?arg=${UUID.randomUUID()}")
                },
                arg = arg,
            )
        }
    }
}

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
content: @Composable ColumnScope.(backstackEntry: NavBackStackEntry) -> Unit	the sheet content at the given destination

NavGraphBuilder.bottomSheet

Cmn

Artifact: androidx.compose.material:material-navigation

View Source

inline fun <T : Any> NavGraphBuilder.bottomSheet(
    typeMap: Map<KType, NavType<*>> = emptyMap(),
    arguments: List<NamedNavArgument> = emptyList(),
    deepLinks: List<NavDeepLink> = emptyList(),
    noinline content: @Composable ColumnScope.(backstackEntry: NavBackStackEntry) -> Unit
): Unit

Add the content as bottom sheet content to the NavGraphBuilder

import androidx.compose.material.Text
import androidx.compose.material.navigation.ModalBottomSheetLayout
import androidx.compose.material.navigation.bottomSheet
import androidx.compose.material.navigation.rememberBottomSheetNavigator
import androidx.navigation.compose.NavHost
import androidx.navigation.compose.composable
import androidx.navigation.compose.rememberNavController

val bottomSheetNavigator = rememberBottomSheetNavigator()
val navController = rememberNavController(bottomSheetNavigator)

ModalBottomSheetLayout(bottomSheetNavigator) {
    NavHost(navController, Destinations.Home) {
        composable(Destinations.Home) {
            HomeScreen(
                showSheet = {
                    navController.navigate(Destinations.Sheet + "?arg=From Home Screen")
                },
                showFeed = { navController.navigate(Destinations.Feed) },
            )
        }
        composable(Destinations.Feed) { Text("Feed!") }
        bottomSheet(Destinations.Sheet + "?arg={arg}") { backstackEntry ->
            val arg = backstackEntry.arguments?.getString("arg") ?: "Missing argument :("
            BottomSheet(
                showFeed = { navController.navigate(Destinations.Feed) },
                showAnotherSheet = {
                    navController.navigate(Destinations.Sheet + "?arg=${UUID.randomUUID()}")
                },
                arg = arg,
            )
        }
    }
}

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.
arguments: List<NamedNavArgument> = emptyList()	list of arguments to associate with destination
deepLinks: List<NavDeepLink> = emptyList()	list of deep links to associate with the destinations
noinline content: @Composable ColumnScope.(backstackEntry: NavBackStackEntry) -> Unit	the sheet content at the given destination