NavigationSuiteScaffoldWithPrimaryActionOverrideScope
@ExperimentalMaterial3AdaptiveComponentOverrideApi
class 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 |
@Composable () -> Unit |
the content of your screen |
Color |
the preferred color to be used for typography and iconography within the passed in |
Modifier |
the |
Arrangement.Vertical |
the vertical arrangement of the items inside vertical navigation components (such as the types |
@Composable () -> Unit |
the navigation items to be displayed, typically |
NavigationSuiteColors |
|
NavigationSuiteType |
the current |
@Composable () -> Unit |
The optional primary action content of the navigation suite scaffold, if any. |
Alignment.Horizontal |
The horizontal alignment of the primary action content, if present, when it's displayed along with a horizontal navigation component. |
NavigationSuiteScaffoldState |
the |
Public properties
containerColor
val containerColor: Color
the color used for the background of the navigation suite scaffold, including the passed content composable. Use Color.Transparent to have no color
contentColor
val contentColor: Color
the preferred color to be used for typography and iconography within the passed in content lambda inside the navigation suite scaffold.
modifier
val modifier: Modifier
the Modifier to be applied to the navigation suite scaffold
navigationItemVerticalArrangement
val navigationItemVerticalArrangement: Arrangement.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
navigationItems
val navigationItems: @Composable () -> Unit
the navigation items to be displayed, typically NavigationSuiteItems
navigationSuiteColors
val navigationSuiteColors: 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
navigationSuiteType
val navigationSuiteType: NavigationSuiteType
the current NavigationSuiteType. Defaults to NavigationSuiteScaffoldDefaults.navigationSuiteType
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 primaryActionContentHorizontalAlignment: Alignment.Horizontal
The horizontal alignment of the primary action content, if present, when it's displayed along with a horizontal navigation component.
state
val state: NavigationSuiteScaffoldState
the NavigationSuiteScaffoldState of this navigation suite scaffold