BottomSheetNavigator

Artifact: androidx.compose.material:material-navigation

View Source

Added in 1.7.0

@<Error class: unknown class>
class 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 specific to BottomSheetNavigator.

Public constructors
BottomSheetNavigator(sheetState: ModalBottomSheetState)

Public functions
open BottomSheetNavigator.Destination	createDestination()
open Unit	navigate(     entries: List<<Error class: unknown class>>,     navOptions: <Error class: unknown class>?,     navigatorExtras: <Error class: unknown class>? )
open Unit	onAttach(state: <Error class: unknown class>)
open Unit	popBackStack(popUpTo: <Error class: unknown class>, savedState: Boolean)

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

Public constructors

BottomSheetNavigator

Added in 1.7.0

BottomSheetNavigator(sheetState: ModalBottomSheetState)

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

Public functions

createDestination

Added in 1.7.0

open fun createDestination(): BottomSheetNavigator.Destination

navigate

open fun navigate(
    entries: List<<Error class: unknown class>>,
    navOptions: <Error class: unknown class>?,
    navigatorExtras: <Error class: unknown class>?
): Unit

onAttach

open fun onAttach(state: <Error class: unknown class>): Unit

popBackStack

open fun popBackStack(popUpTo: <Error class: unknown class>, savedState: Boolean): Unit

Public properties

navigatorSheetState

Added in 1.7.0

val navigatorSheetState: BottomSheetNavigatorSheetState

Access properties of the ModalBottomSheetLayout's ModalBottomSheetState