NavigationSuiteScaffoldLayout

Functions summary

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

Functions

@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

@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