NavigationSuite

The default Material navigation component according to the current NavigationSuiteType to be used with the NavigationSuiteScaffold.

Common

@Composable
fun NavigationSuite(
    navigationSuiteType: NavigationSuiteType,
    modifier: Modifier = Modifier,
    colors: NavigationSuiteColors = NavigationSuiteDefaults.colors(),
    verticalArrangement: Arrangement.Vertical = NavigationSuiteDefaults.verticalArrangement,
    primaryActionContent: @Composable (() -> Unit) = {},
    content: @Composable () -> Unit,
)

The default Material navigation component according to the current NavigationSuiteType to be used with the NavigationSuiteScaffold.

For specifics about each navigation component, see ShortNavigationBar, WideNavigationRail, NavigationRail, and PermanentDrawerSheet.

Parameters


navigationSuiteType	the NavigationSuiteType of the associated NavigationSuiteScaffold. Usually NavigationSuiteScaffoldDefaults.navigationSuiteType
modifier	the Modifier to be applied to the navigation component
colors	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
verticalArrangement	the vertical arrangement of the items inside vertical navigation components, such as the wide navigation rail. It's recommended to use Arrangement.Top, Arrangement.Center, or Arrangement.Bottom.
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 their header, and above horizontal navigation components.
content	the content inside the current navigation component, typically NavigationSuiteItems

NavigationSuite

Common

@Composable
fun NavigationSuite(
    modifier: Modifier = Modifier,
    layoutType: NavigationSuiteType =
        NavigationSuiteScaffoldDefaults.calculateFromAdaptiveInfo(WindowAdaptiveInfoDefault),
    colors: NavigationSuiteColors = NavigationSuiteDefaults.colors(),
    content: NavigationSuiteScope.() -> Unit,
)

The default Material navigation component according to the current NavigationSuiteType to be used with the NavigationSuiteScaffold.

Note: It is recommended to use the NavigationSuite function with the navigationSuiteType param and that accepts NavigationSuiteItems instead of this one.

For specifics about each navigation component, see NavigationBar, NavigationRail, and PermanentDrawerSheet.

Parameters


modifier	the Modifier to be applied to the navigation component
layoutType	the current NavigationSuiteType of the NavigationSuiteScaffold. Defaults to NavigationSuiteScaffoldDefaults.calculateFromAdaptiveInfo
colors	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
content	the content inside the current navigation component, typically NavigationSuiteScope.items