Start native apps faster with the Composables CLI ->
Compose Component

NavigationSuiteScaffoldLayout

Layout for a NavigationSuiteScaffold's content.

NavigationSuiteScaffoldLayout

Source set: Common
@Composable
public fun NavigationSuiteScaffoldLayout(
    navigationSuite: @Composable () -> Unit,
    navigationSuiteType: NavigationSuiteType,
    state: NavigationSuiteScaffoldState = rememberNavigationSuiteScaffoldState(),
    primaryActionContent: @Composable (() -> Unit) = {},
    primaryActionContentHorizontalAlignment: Alignment.Horizontal =
        NavigationSuiteScaffoldDefaults.primaryActionContentAlignment,
    content: @Composable () -> Unit,
)

Parameters
navigationSuite the navigation component to be displayed, typically NavigationSuite
navigationSuiteType the current NavigationSuiteType. Usually NavigationSuiteScaffoldDefaults.navigationSuiteType
state the NavigationSuiteScaffoldState of this navigation suite scaffold layout
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

NavigationSuiteScaffoldLayout

Source set: Common
@Composable
public fun NavigationSuiteScaffoldLayout(
    navigationSuite: @Composable () -> Unit,
    layoutType: NavigationSuiteType =
        NavigationSuiteScaffoldDefaults.calculateFromAdaptiveInfo(WindowAdaptiveInfoDefault),
    state: NavigationSuiteScaffoldState = rememberNavigationSuiteScaffoldState(),
    content: @Composable () -> Unit = {},
)

Parameters
navigationSuite the navigation component to be displayed, typically NavigationSuite
layoutType the current NavigationSuiteType. Defaults to NavigationSuiteScaffoldDefaults.calculateFromAdaptiveInfo
state the NavigationSuiteScaffoldState of this navigation suite scaffold layout
content the content of your screen

NavigationSuiteScaffoldLayout

Source set: Common
@Deprecated(
    message = "Deprecated in favor of NavigationSuiteScaffoldLayout with state parameter",
    level = DeprecationLevel.HIDDEN,
)
@Composable
public fun NavigationSuiteScaffoldLayout(
    navigationSuite: @Composable () -> Unit,
    layoutType: NavigationSuiteType =
        NavigationSuiteScaffoldDefaults.calculateFromAdaptiveInfo(WindowAdaptiveInfoDefault),
    content: @Composable () -> Unit = {},
): Unit

Parameters
navigationSuite the navigation component to be displayed, typically NavigationSuite
layoutType the current NavigationSuiteType. Defaults to NavigationSuiteScaffoldDefaults.calculateFromAdaptiveInfo
content the content of your screen