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