androidx.compose.material3.adaptive.navigationsuite

Interfaces

NavigationSuiteScaffoldOverride

Interface that allows libraries to override the behavior of the NavigationSuiteScaffold component.
Cmn
NavigationSuiteScaffoldState

A state object that can be hoisted to observe the navigation suite scaffold state.
Cmn
NavigationSuiteScope

The scope associated with the NavigationSuiteScope.
Cmn

Classes

NavigationSuiteColors

Represents the colors of a NavigationSuite.
Cmn
NavigationSuiteItemColors

Represents the colors of a NavigationSuiteScope.item.
Cmn
NavigationSuiteScaffoldOverrideScope

Parameters available to NavigationSuiteScaffold.
Cmn
NavigationSuiteType

Class that describes the different navigation suite types of the NavigationSuiteScaffold.
Cmn

Objects

DefaultNavigationSuiteScaffoldOverride

This override provides the default behavior of the NavigationSuiteScaffold component.
Cmn
NavigationSuiteDefaults

Contains the default values used by the NavigationSuite.
Cmn
NavigationSuiteScaffoldDefaults

Contains the default values used by the NavigationSuiteScaffold.
Cmn

Annotations

ExperimentalMaterial3AdaptiveNavigationSuiteApi
Cmn

Enums

NavigationSuiteScaffoldValue

Possible values of NavigationSuiteScaffoldState.
Cmn

Top-level 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
Unit
@Composable
NavigationSuiteItem(
    selected: Boolean,
    onClick: () -> Unit,
    icon: @Composable () -> Unit,
    label: (@Composable () -> Unit)?,
    modifier: Modifier,
    navigationSuiteType: NavigationSuiteType,
    enabled: Boolean,
    badge: (@Composable () -> Unit)?,
    colors: NavigationItemColors?,
    interactionSource: MutableInteractionSource?
)

The default Material navigation item component according to the current NavigationSuiteType to be used with the NavigationSuite that accepts this function.
Cmn
Unit
@Composable
NavigationSuiteScaffold(
    navigationSuiteItems: NavigationSuiteScope.() -> Unit,
    modifier: Modifier,
    layoutType: NavigationSuiteType,
    navigationSuiteColors: NavigationSuiteColors,
    containerColor: Color,
    contentColor: Color,
    state: NavigationSuiteScaffoldState,
    content: @Composable () -> Unit
)

The Navigation Suite Scaffold wraps the provided content and places the adequate provided navigation component on the screen according to the current NavigationSuiteType.
Cmn
Unit
@Composable
NavigationSuiteScaffold(
    navigationItems: @Composable () -> Unit,
    modifier: Modifier,
    navigationSuiteType: NavigationSuiteType,
    navigationSuiteColors: NavigationSuiteColors,
    containerColor: Color,
    contentColor: Color,
    state: NavigationSuiteScaffoldState,
    navigationItemVerticalArrangement: Arrangement.Vertical,
    primaryActionContent: @Composable () -> Unit,
    primaryActionContentHorizontalAlignment: Alignment.Horizontal,
    content: @Composable () -> Unit
)

The Navigation Suite Scaffold wraps the provided content and places the adequate provided navigation component on the screen according to the current NavigationSuiteType.
Cmn
Unit
@Composable
NavigationSuiteScaffoldLayout(
    navigationSuite: @Composable () -> Unit,
    layoutType: NavigationSuiteType,
    state: NavigationSuiteScaffoldState,
    content: @Composable () -> Unit
)

Layout for a NavigationSuiteScaffold's content.
Cmn
Unit
@Composable
NavigationSuiteScaffoldLayout(
    navigationSuite: @Composable () -> Unit,
    navigationSuiteType: NavigationSuiteType,
    state: NavigationSuiteScaffoldState,
    primaryActionContent: @Composable () -> Unit,
    primaryActionContentHorizontalAlignment: Alignment.Horizontal,
    content: @Composable () -> Unit
)

Layout for a NavigationSuiteScaffold's content.
Cmn
NavigationSuiteScaffoldState

Create and remember a NavigationSuiteScaffoldState
Cmn

Top-level properties summary

ProvidableCompositionLocal<NavigationSuiteScaffoldOverride>

CompositionLocal containing the currently-selected NavigationSuiteScaffoldOverride.
Cmn

Top-level 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
Cmn 
@Composable
fun NavigationSuiteItem(
    selected: Boolean,
    onClick: () -> Unit,
    icon: @Composable () -> Unit,
    label: (@Composable () -> Unit)?,
    modifier: Modifier = Modifier,
    navigationSuiteType: NavigationSuiteType = NavigationSuiteScaffoldDefaults.navigationSuiteType(WindowAdaptiveInfoDefault),
    enabled: Boolean = true,
    badge: (@Composable () -> Unit)? = null,
    colors: NavigationItemColors? = null,
    interactionSource: MutableInteractionSource? = null
): Unit

The default Material navigation item component according to the current NavigationSuiteType to be used with the NavigationSuite that accepts this function.

For specifics about each navigation component, see ShortNavigationBarItem, WideNavigationRailItem, NavigationRailItem, and NavigationDrawerItem.

Parameters
selected: Boolean

whether this item is selected
onClick: () -> Unit

called when this item is clicked
icon: @Composable () -> Unit

icon for this item, typically an Icon
label: (@Composable () -> Unit)?

the text label for this item
modifier: Modifier = Modifier

the Modifier to be applied to this item
navigationSuiteType: NavigationSuiteType = NavigationSuiteScaffoldDefaults.navigationSuiteType(WindowAdaptiveInfoDefault)

the current NavigationSuiteType of the associated NavigationSuite. Defaults to NavigationSuiteScaffoldDefaults.navigationSuiteType
enabled: Boolean = true

controls the enabled state of this item. When false, this component will not respond to user input, and it will appear visually disabled and disabled to accessibility services. Note: as of now, for NavigationDrawerItem, this is always true.
badge: (@Composable () -> Unit)? = null

optional badge to show on this item
colors: NavigationItemColors? = null

NavigationItemColors that will be used to resolve the colors used for this item in different states. If null, a default Material colors for each specific item will be used.
interactionSource: MutableInteractionSource? = null

an optional hoisted MutableInteractionSource for observing and emitting Interactions for this item. You can use this to change the item's appearance or preview the item in different states. Note that if null is provided, interactions will still happen internally.
Cmn 
@Composable
fun NavigationSuiteScaffold(
    navigationSuiteItems: NavigationSuiteScope.() -> Unit,
    modifier: Modifier = Modifier,
    layoutType: NavigationSuiteType = NavigationSuiteScaffoldDefaults.calculateFromAdaptiveInfo(WindowAdaptiveInfoDefault),
    navigationSuiteColors: NavigationSuiteColors = NavigationSuiteDefaults.colors(),
    containerColor: Color = NavigationSuiteScaffoldDefaults.containerColor,
    contentColor: Color = NavigationSuiteScaffoldDefaults.contentColor,
    state: NavigationSuiteScaffoldState = rememberNavigationSuiteScaffoldState(),
    content: @Composable () -> Unit = {}
): Unit

The Navigation Suite Scaffold wraps the provided content and places the adequate provided navigation component on the screen according to the current NavigationSuiteType.

Note: It is recommended to use the NavigationSuiteScaffold function with the navigationItems param that accepts NavigationSuiteItems instead of this one.

The navigation component can be animated to be hidden or shown via a NavigationSuiteScaffoldState.

Parameters
navigationSuiteItems: NavigationSuiteScope.() -> Unit

the navigation items to be displayed
modifier: Modifier = Modifier

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

the current NavigationSuiteType. Defaults to NavigationSuiteScaffoldDefaults.calculateFromAdaptiveInfo
navigationSuiteColors: 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
containerColor: Color = NavigationSuiteScaffoldDefaults.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: Color = NavigationSuiteScaffoldDefaults.contentColor

the preferred color to be used for typography and iconography within the passed in content lambda inside the navigation suite scaffold.
state: NavigationSuiteScaffoldState = rememberNavigationSuiteScaffoldState()

the NavigationSuiteScaffoldState of this navigation suite scaffold
content: @Composable () -> Unit = {}

the content of your screen
Cmn 
@Composable
fun NavigationSuiteScaffold(
    navigationItems: @Composable () -> Unit,
    modifier: Modifier = Modifier,
    navigationSuiteType: NavigationSuiteType = NavigationSuiteScaffoldDefaults.navigationSuiteType(WindowAdaptiveInfoDefault),
    navigationSuiteColors: NavigationSuiteColors = NavigationSuiteDefaults.colors(),
    containerColor: Color = NavigationSuiteScaffoldDefaults.containerColor,
    contentColor: Color = NavigationSuiteScaffoldDefaults.contentColor,
    state: NavigationSuiteScaffoldState = rememberNavigationSuiteScaffoldState(),
    navigationItemVerticalArrangement: Arrangement.Vertical = NavigationSuiteDefaults.verticalArrangement,
    primaryActionContent: @Composable () -> Unit = {},
    primaryActionContentHorizontalAlignment: Alignment.Horizontal = NavigationSuiteScaffoldDefaults.primaryActionContentAlignment,
    content: @Composable () -> Unit
): Unit

The Navigation Suite Scaffold wraps the provided content and places the adequate provided navigation component on the screen according to the current NavigationSuiteType.

The navigation component can be animated to be hidden or shown via a NavigationSuiteScaffoldState.

The scaffold also supports an optional primary action composable, such as a floating action button, which will be displayed according to the current NavigationSuiteType.

A simple usage example looks like this:

import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.fillMaxWidth
import androidx.compose.foundation.layout.padding
import androidx.compose.material.icons.Icons
import androidx.compose.material.icons.filled.Favorite
import androidx.compose.material.icons.outlined.FavoriteBorder
import androidx.compose.material3.Button
import androidx.compose.material3.Icon
import androidx.compose.material3.Text
import androidx.compose.material3.adaptive.currentWindowAdaptiveInfo
import androidx.compose.material3.adaptive.navigationsuite.NavigationSuiteItem
import androidx.compose.material3.adaptive.navigationsuite.NavigationSuiteScaffold
import androidx.compose.material3.adaptive.navigationsuite.NavigationSuiteScaffoldDefaults
import androidx.compose.material3.adaptive.navigationsuite.NavigationSuiteType
import androidx.compose.material3.adaptive.navigationsuite.rememberNavigationSuiteScaffoldState
import androidx.compose.runtime.mutableIntStateOf
import androidx.compose.runtime.remember
import androidx.compose.runtime.rememberCoroutineScope
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.text.style.TextAlign
import androidx.compose.ui.unit.dp

var selectedItem by remember { mutableIntStateOf(0) }
val navItems = listOf("Songs", "Artists", "Playlists")
val navSuiteType =
    NavigationSuiteScaffoldDefaults.navigationSuiteType(currentWindowAdaptiveInfo())
val state = rememberNavigationSuiteScaffoldState()
val scope = rememberCoroutineScope()

NavigationSuiteScaffold(
    state = state,
    navigationItems = {
        navItems.forEachIndexed { index, navItem ->
            NavigationSuiteItem(
                icon = {
                    Icon(
                        if (selectedItem == index) Icons.Filled.Favorite
                        else Icons.Outlined.FavoriteBorder,
                        contentDescription = null
                    )
                },
                label = { Text(navItem) },
                selected = selectedItem == index,
                onClick = { selectedItem = index }
            )
        }
    }
) {
    // Screen content.
    Column(
        modifier = Modifier.fillMaxWidth(),
        horizontalAlignment = Alignment.CenterHorizontally
    ) {
        Text(
            modifier = Modifier.padding(16.dp),
            text =
                "Current NavigationSuiteType: $navSuiteType\n" +
                    "Visibility: ${state.currentValue}",
            textAlign = TextAlign.Center
        )
        Button(onClick = { scope.launch { state.toggle() } }) {
            Text("Hide/show navigation component")
        }
    }
}

An usage with custom layout choices looks like this:

import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.fillMaxWidth
import androidx.compose.foundation.layout.padding
import androidx.compose.material.icons.Icons
import androidx.compose.material.icons.filled.Favorite
import androidx.compose.material.icons.outlined.FavoriteBorder
import androidx.compose.material3.Button
import androidx.compose.material3.Icon
import androidx.compose.material3.Text
import androidx.compose.material3.adaptive.currentWindowAdaptiveInfo
import androidx.compose.material3.adaptive.navigationsuite.NavigationSuiteItem
import androidx.compose.material3.adaptive.navigationsuite.NavigationSuiteScaffold
import androidx.compose.material3.adaptive.navigationsuite.NavigationSuiteScaffoldDefaults
import androidx.compose.material3.adaptive.navigationsuite.NavigationSuiteType
import androidx.compose.material3.adaptive.navigationsuite.rememberNavigationSuiteScaffoldState
import androidx.compose.runtime.mutableIntStateOf
import androidx.compose.runtime.remember
import androidx.compose.runtime.rememberCoroutineScope
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.text.style.TextAlign
import androidx.compose.ui.unit.dp
import androidx.window.core.layout.WindowHeightSizeClass
import androidx.window.core.layout.WindowWidthSizeClass

var selectedItem by remember { mutableIntStateOf(0) }
val navItems = listOf("Songs", "Artists", "Playlists")
// Custom configuration that shows a wide navigation rail in small/medium width screens, an
// expanded wide navigation rail in expanded width screens, and a short navigation bar in small
// height screens.
val navSuiteType =
    with(currentWindowAdaptiveInfo()) {
        if (
            windowSizeClass.windowWidthSizeClass == WindowWidthSizeClass.COMPACT ||
                windowSizeClass.windowWidthSizeClass == WindowWidthSizeClass.MEDIUM
        ) {
            NavigationSuiteType.WideNavigationRailCollapsed
        } else if (windowSizeClass.windowHeightSizeClass == WindowHeightSizeClass.COMPACT) {
            NavigationSuiteType.ShortNavigationBarMedium
        } else if (windowSizeClass.windowWidthSizeClass == WindowWidthSizeClass.EXPANDED) {
            NavigationSuiteType.WideNavigationRailExpanded
        } else {
            NavigationSuiteScaffoldDefaults.navigationSuiteType(currentWindowAdaptiveInfo())
        }
    }
val state = rememberNavigationSuiteScaffoldState()
val scope = rememberCoroutineScope()

NavigationSuiteScaffold(
    navigationSuiteType = navSuiteType,
    state = state,
    navigationItemVerticalArrangement = Arrangement.Center,
    navigationItems = {
        navItems.forEachIndexed { index, navItem ->
            NavigationSuiteItem(
                navigationSuiteType = navSuiteType,
                icon = {
                    Icon(
                        if (selectedItem == index) Icons.Filled.Favorite
                        else Icons.Outlined.FavoriteBorder,
                        contentDescription = null
                    )
                },
                label = { Text(navItem) },
                selected = selectedItem == index,
                onClick = { selectedItem = index }
            )
        }
    }
) {
    // Screen content.
    Column(
        modifier = Modifier.fillMaxWidth(),
        horizontalAlignment = Alignment.CenterHorizontally
    ) {
        Text(
            modifier = Modifier.padding(16.dp),
            text =
                "Current NavigationSuiteType: $navSuiteType\n" +
                    "Visibility: ${state.currentValue}",
            textAlign = TextAlign.Center
        )
        Button(onClick = { scope.launch { state.toggle() } }) {
            Text("Hide/show navigation component")
        }
    }
}
Parameters
navigationItems: @Composable () -> Unit

the navigation items to be displayed, typically NavigationSuiteItems
modifier: Modifier = Modifier

the Modifier to be applied to the navigation suite scaffold
navigationSuiteType: NavigationSuiteType = NavigationSuiteScaffoldDefaults.navigationSuiteType(WindowAdaptiveInfoDefault)

the current NavigationSuiteType. Defaults to NavigationSuiteScaffoldDefaults.navigationSuiteType
navigationSuiteColors: 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
containerColor: Color = NavigationSuiteScaffoldDefaults.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: Color = NavigationSuiteScaffoldDefaults.contentColor

the preferred color to be used for typography and iconography within the passed in content lambda inside the navigation suite scaffold.
state: NavigationSuiteScaffoldState = rememberNavigationSuiteScaffoldState()

the NavigationSuiteScaffoldState of this navigation suite scaffold
navigationItemVerticalArrangement: Arrangement.Vertical = NavigationSuiteDefaults.verticalArrangement

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: @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: Alignment.Horizontal = NavigationSuiteScaffoldDefaults.primaryActionContentAlignment

The horizontal alignment of the primary action content, if present, when it's displayed along with a horizontal navigation component.
content: @Composable () -> Unit

the content of your screen
Cmn 
@Composable
fun NavigationSuiteScaffoldLayout(
    navigationSuite: @Composable () -> Unit,
    layoutType: NavigationSuiteType = NavigationSuiteScaffoldDefaults.calculateFromAdaptiveInfo(WindowAdaptiveInfoDefault),
    state: NavigationSuiteScaffoldState = rememberNavigationSuiteScaffoldState(),
    content: @Composable () -> Unit = {}
): Unit

Layout for a NavigationSuiteScaffold's content. This function wraps the content and places the navigationSuite component according to the given layoutType.

Note: It is recommended to use the NavigationSuiteScaffoldLayout function with the navigationSuiteType param instead of this one.

The usage of this function is recommended when you need some customization that is not viable via the use of NavigationSuiteScaffold.

Parameters
navigationSuite: @Composable () -> Unit

the navigation component to be displayed, typically NavigationSuite
layoutType: NavigationSuiteType = NavigationSuiteScaffoldDefaults.calculateFromAdaptiveInfo(WindowAdaptiveInfoDefault)

the current NavigationSuiteType. Defaults to NavigationSuiteScaffoldDefaults.calculateFromAdaptiveInfo
state: NavigationSuiteScaffoldState = rememberNavigationSuiteScaffoldState()

the NavigationSuiteScaffoldState of this navigation suite scaffold layout
content: @Composable () -> Unit = {}

the content of your screen
Cmn 
@Composable
fun NavigationSuiteScaffoldLayout(
    navigationSuite: @Composable () -> Unit,
    navigationSuiteType: NavigationSuiteType,
    state: NavigationSuiteScaffoldState = rememberNavigationSuiteScaffoldState(),
    primaryActionContent: @Composable () -> Unit = {},
    primaryActionContentHorizontalAlignment: Alignment.Horizontal = NavigationSuiteScaffoldDefaults.primaryActionContentAlignment,
    content: @Composable () -> Unit
): Unit

Layout for a NavigationSuiteScaffold's content. This function wraps the content and places the navigationSuite, and the primaryActionContent, if any, according to the current NavigationSuiteType.

The usage of this function is recommended when you need some customization that is not viable via the use of NavigationSuiteScaffold. An usage example of using a custom modal wide rail can be found at androidx.compose.material3.demos.NavigationSuiteScaffoldCustomConfigDemo.

Parameters
navigationSuite: @Composable () -> Unit

the navigation component to be displayed, typically NavigationSuite
navigationSuiteType: NavigationSuiteType

the current NavigationSuiteType. Usually NavigationSuiteScaffoldDefaults.navigationSuiteType
state: NavigationSuiteScaffoldState = rememberNavigationSuiteScaffoldState()

the NavigationSuiteScaffoldState of this navigation suite scaffold layout
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: Alignment.Horizontal = NavigationSuiteScaffoldDefaults.primaryActionContentAlignment

The horizontal alignment of the primary action content, if present, when it's displayed along with a horizontal navigation component.
content: @Composable () -> Unit

the content of your screen

rememberNavigationSuiteScaffoldState

Cmn 
@Composable
fun rememberNavigationSuiteScaffoldState(
    initialValue: NavigationSuiteScaffoldValue = NavigationSuiteScaffoldValue.Visible
): NavigationSuiteScaffoldState

Create and remember a NavigationSuiteScaffoldState

Top-level properties

LocalNavigationSuiteScaffoldOverride

Cmn 
@ExperimentalMaterial3AdaptiveComponentOverrideApi
val LocalNavigationSuiteScaffoldOverride: ProvidableCompositionLocal<NavigationSuiteScaffoldOverride>

CompositionLocal containing the currently-selected NavigationSuiteScaffoldOverride.