BottomSheetNavigator

Added in 1.7.0

@<Error class: unknown class>
class BottomSheetNavigator : Navigator

kotlin.Any
↳	androidx.navigation.Navigator
	↳	androidx.compose.material.navigation.BottomSheetNavigator

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.compose.material.navigation.bottomSheet.

The sheetContent will always host the latest entry of the back stack. When navigating from a BottomSheetNavigator.Destination to another BottomSheetNavigator.Destination, the content of the sheet will be replaced instead of a new bottom sheet being shown.

When the sheet is dismissed by the user, the state's NavigatorState.backStack will be popped.

See also
`rememberBottomSheetNavigator`	()

Summary

Nested types
`@<Error class: unknown class> class BottomSheetNavigator.Destination : NavDestination, FloatingWindow` `NavDestination` specific to `BottomSheetNavigator`.

Public constructors
`BottomSheetNavigator(sheetState: ModalBottomSheetState)`

Public functions
`open BottomSheetNavigator.Destination`	`createDestination()`
`open Unit`	`navigate( entries: List<NavBackStackEntry>, navOptions: NavOptions?, navigatorExtras: Navigator.Extras? )`
`open Unit`	`onAttach(state: NavigatorState)`
`open Unit`	`popBackStack(popUpTo: NavBackStackEntry, savedState: Boolean)`

Public properties
`BottomSheetNavigatorSheetState`	`navigatorSheetState` Access properties of the `ModalBottomSheetLayout`'s `ModalBottomSheetState`

`open NavDestination?`	`navigate( destination: BottomSheetNavigator.Destination, args: SavedState?, navOptions: NavOptions?, navigatorExtras: Navigator.Extras? )`
`open Unit`	`onLaunchSingleTop(backStackEntry: NavBackStackEntry)`
`open Unit`	`onRestoreState(savedState: SavedState)`
`open SavedState?`	`onSaveState()`
`open Boolean`	`popBackStack()`

`Boolean`	`isAttached`
`NavigatorState`	`state`

Added in 1.7.0

BottomSheetNavigator(sheetState: ModalBottomSheetState)

Parameters
`sheetState: ModalBottomSheetState`	The `ModalBottomSheetState` that the `BottomSheetNavigator` will use to drive the sheet state

Added in 1.7.0

open fun createDestination(): BottomSheetNavigator.Destination

open fun navigate(
    entries: List<NavBackStackEntry>,
    navOptions: NavOptions?,
    navigatorExtras: Navigator.Extras?
): Unit

open fun onAttach(state: NavigatorState): Unit

open fun popBackStack(popUpTo: NavBackStackEntry, savedState: Boolean): Unit

Added in 1.7.0

val navigatorSheetState: BottomSheetNavigatorSheetState