navigation-material/com.google.accompanist.navigation.material

Package-level declarations

Types

class BottomSheetNavigator(sheetState: ModalBottomSheetState) : Navigator<BottomSheetNavigator.Destination>

Navigator that drives a ModalBottomSheetState for use of ModalBottomSheetLayouts with the navigation library. Every destination using this Navigator must set a valid Composable by setting it directly on an instantiated Destination or calling androidx.navigation.compose.material.bottomSheet.

BottomSheetNavigatorSheetState

@Stable

class BottomSheetNavigatorSheetState(sheetState: ModalBottomSheetState)

The state of a ModalBottomSheetLayout that the BottomSheetNavigator drives

ExperimentalMaterialNavigationApi

annotation class ExperimentalMaterialNavigationApi

Functions

bottomSheet

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

Add the content as bottom sheet content to the NavGraphBuilder

ModalBottomSheetLayout

@Composable

fun ModalBottomSheetLayout(bottomSheetNavigator: BottomSheetNavigator, modifier: Modifier = Modifier, sheetShape: Shape = MaterialTheme.shapes.large, sheetElevation: Dp = ModalBottomSheetDefaults.Elevation, sheetBackgroundColor: Color = MaterialTheme.colors.surface, sheetContentColor: Color = contentColorFor(sheetBackgroundColor), scrimColor: Color = ModalBottomSheetDefaults.scrimColor, content: @Composable () -> Unit)

Helper function to create a ModalBottomSheetLayout from a BottomSheetNavigator.

rememberBottomSheetNavigator

@Composable

fun rememberBottomSheetNavigator(animationSpec: AnimationSpec<Float> = SpringSpec<Float>()): BottomSheetNavigator

Create and remember a BottomSheetNavigator