NavigationSuite

Functions summary

Unit
@Composable
NavigationSuite(
    modifier: Modifier,
    layoutType: NavigationSuiteType,
    colors: NavigationSuiteColors,
    content: NavigationSuiteScope.() -> Unit
)

The default Material navigation component according to the current NavigationSuiteType to be used with the NavigationSuiteScaffold.
Cmn
Unit
@Composable
NavigationSuite(
    navigationSuiteType: NavigationSuiteType,
    modifier: Modifier,
    colors: NavigationSuiteColors,
    verticalArrangement: Arrangement.Vertical,
    primaryActionContent: @Composable () -> Unit,
    content: @Composable () -> Unit
)

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

Functions

Cmn 
@Composable
fun NavigationSuite(
    modifier: Modifier = Modifier,
    layoutType: NavigationSuiteType = NavigationSuiteScaffoldDefaults.calculateFromAdaptiveInfo(WindowAdaptiveInfoDefault),
    colors: NavigationSuiteColors = NavigationSuiteDefaults.colors(),
    content: NavigationSuiteScope.() -> Unit
): 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: Modifier = Modifier

the Modifier to be applied to the navigation component
layoutType: NavigationSuiteType = NavigationSuiteScaffoldDefaults.calculateFromAdaptiveInfo(WindowAdaptiveInfoDefault)

the current NavigationSuiteType of the NavigationSuiteScaffold. Defaults to NavigationSuiteScaffoldDefaults.calculateFromAdaptiveInfo
colors: NavigationSuiteColors = NavigationSuiteDefaults.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: NavigationSuiteScope.() -> Unit

the content inside the current navigation component, typically NavigationSuiteScope.items
Cmn 
@Composable
fun NavigationSuite(
    navigationSuiteType: NavigationSuiteType,
    modifier: Modifier = Modifier,
    colors: NavigationSuiteColors = NavigationSuiteDefaults.colors(),
    verticalArrangement: Arrangement.Vertical = NavigationSuiteDefaults.verticalArrangement,
    primaryActionContent: @Composable () -> Unit = {},
    content: @Composable () -> Unit
): 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: NavigationSuiteType

the NavigationSuiteType of the associated NavigationSuiteScaffold. Usually NavigationSuiteScaffoldDefaults.navigationSuiteType
modifier: Modifier = Modifier

the Modifier to be applied to the navigation component
colors: NavigationSuiteColors = NavigationSuiteDefaults.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: Arrangement.Vertical = NavigationSuiteDefaults.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: @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 their header, and above horizontal navigation components.
content: @Composable () -> Unit

the content inside the current navigation component, typically NavigationSuiteItems