Compose Multiplatform Material3/androidx.compose.material3/WideNavigationRailOverrideScope

WideNavigationRailOverrideScope

class WideNavigationRailOverrideScope

Parameters available to WideNavigationRail.

Parameters

modifier

the Modifier to be applied to this wide navigation rail

state

the WideNavigationRailState of this wide navigation rail

shape

defines the shape of this wide navigation rail's container.

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

windowInsets

a window insets of the wide navigation rail

arrangement

the Arrangement.Vertical of this wide navigation rail for its content. Note that if there's a header present, the items will be arranged on the remaining space below it, except for the center arrangement which considers the entire height of the container

content

the content of this wide navigation rail, typically WideNavigationRailItems

Properties

Link copied to clipboard
val arrangement: Arrangement.Vertical
Link copied to clipboard
Link copied to clipboard
val content: @Composable () -> Unit
Link copied to clipboard
val header: @Composable () -> Unit?
Link copied to clipboard
val modifier: Modifier
Link copied to clipboard
val shape: Shape
Link copied to clipboard
Link copied to clipboard
val windowInsets: WindowInsets

Functions

Link copied to clipboard
@Composable
open override fun WideNavigationRailOverrideScope.WideNavigationRail()

Behavior function that is called by the WideNavigationRail component.