NavigationSuiteScaffoldWithPrimaryActionOverrideScope


Parameters available to NavigationSuiteScaffold that includes a primary action.

Summary

Public properties

Color

the color used for the background of the navigation suite scaffold, including the passed content composable.

Cmn
@Composable () -> Unit

the content of your screen

Cmn
Color

the preferred color to be used for typography and iconography within the passed in content lambda inside the navigation suite scaffold.

Cmn
Modifier

the Modifier to be applied to the navigation suite scaffold

Cmn
Arrangement.Vertical

the vertical arrangement of the items inside vertical navigation components (such as the types NavigationSuiteType.WideNavigationRailCollapsed and NavigationSuiteType.WideNavigationRailExpanded).

Cmn
@Composable () -> Unit

the navigation items to be displayed, typically NavigationSuiteItems

Cmn
NavigationSuiteColors

NavigationSuiteColors that will be used to determine the container (background) color of the navigation component and the preferred color for content inside the navigation component

Cmn
NavigationSuiteType

the current NavigationSuiteType.

Cmn
@Composable () -> Unit

The optional primary action content of the navigation suite scaffold, if any.

Cmn
Alignment.Horizontal

The horizontal alignment of the primary action content, if present, when it's displayed along with a horizontal navigation component.

Cmn
NavigationSuiteScaffoldState

the NavigationSuiteScaffoldState of this navigation suite scaffold

Cmn

Public properties

containerColor

val containerColorColor

the color used for the background of the navigation suite scaffold, including the passed content composable. Use Color.Transparent to have no color

content

val content: @Composable () -> Unit

the content of your screen

contentColor

val contentColorColor

the preferred color to be used for typography and iconography within the passed in content lambda inside the navigation suite scaffold.

modifier

val modifierModifier

the Modifier to be applied to the navigation suite scaffold

val navigationItemVerticalArrangementArrangement.Vertical

the vertical arrangement of the items inside vertical navigation components (such as the types NavigationSuiteType.WideNavigationRailCollapsed and NavigationSuiteType.WideNavigationRailExpanded). It's recommended to use Arrangement.Top, Arrangement.Center, or Arrangement.Bottom. Defaults to Arrangement.Top

val navigationItems: @Composable () -> Unit

the navigation items to be displayed, typically NavigationSuiteItems

val navigationSuiteColorsNavigationSuiteColors

NavigationSuiteColors that will be used to determine the container (background) color of the navigation component and the preferred color for content inside the navigation component

primaryActionContent

val primaryActionContent: @Composable () -> Unit

The optional primary action content of the navigation suite scaffold, if any. Typically a androidx.compose.material3.FloatingActionButton. It'll be displayed inside vertical navigation components as part of their header , and above horizontal navigation components.

primaryActionContentHorizontalAlignment

val primaryActionContentHorizontalAlignmentAlignment.Horizontal

The horizontal alignment of the primary action content, if present, when it's displayed along with a horizontal navigation component.

state

val stateNavigationSuiteScaffoldState

the NavigationSuiteScaffoldState of this navigation suite scaffold