ModalWideNavigationRailOverrideScope

Class

Common

@ExperimentalMaterial3ComponentOverrideApi
class ModalWideNavigationRailOverrideScope
internal constructor(
    val modifier: Modifier,
    val state: WideNavigationRailState,
    @get:Suppress("GetterSetterNames") val shouldHideOnCollapse: Boolean,
    val collapsedShape: Shape,
    val expandedShape: Shape,
    val colors: WideNavigationRailColors,
    val header: @Composable (() -> Unit)?,
    val expandedHeaderTopPadding: Dp,
    val windowInsets: WindowInsets,
    val arrangement: Arrangement.Vertical,
    val expandedProperties: ModalWideNavigationRailProperties,
    val content: @Composable () -> Unit,
)

Parameters available to ModalWideNavigationRail.

Parameters


modifier	the `Modifier` to be applied to this wide navigation rail
state	the `WideNavigationRailState` of this wide navigation rail
shouldHideOnCollapse	whether this wide navigation rail should slide offscreen when it collapses and be hidden, or stay on screen as a collapsed wide navigation rail (default)
collapsedShape	the shape of this wide navigation rail's container when it's collapsed
expandedShape	the shape of this wide navigation rail's container when it's expanded
colors	`WideNavigationRailColors` that will be used to resolve the colors used for this wide navigation rail. See `WideNavigationRailDefaults.colors`
header	optional header that may hold a `FloatingActionButton` or a logo
expandedHeaderTopPadding	the padding to be applied to the top of the rail. It's usually needed in order to align the content of the rail between the collapsed and expanded animation
windowInsets	a window insets of the wide navigation rail
arrangement	the `Arrangement.Vertical` of this wide navigation rail
expandedProperties	`ModalWideNavigationRailProperties` for further customization of the expanded modal wide navigation rail's window behavior
content	the content of this modal wide navigation rail, usually `WideNavigationRailItem`s