NavigationSuiteScaffold

Functions summary

Unit
@ExperimentalMaterial3XrApi
@Composable
NavigationSuiteScaffold(
    navigationSuiteItems: NavigationSuiteScope.() -> Unit,
    modifier: SubspaceModifier,
    layoutType: NavigationSuiteType,
    navigationSuiteColors: NavigationSuiteColors,
    state: NavigationSuiteScaffoldState,
    content: @Composable () -> Unit
)

XR-specific Navigation Suite Scaffold that wraps its content in a SpatialPanel.

Functions

@ExperimentalMaterial3XrApi
@Composable
fun NavigationSuiteScaffold(
    navigationSuiteItems: NavigationSuiteScope.() -> Unit,
    modifier: SubspaceModifier,
    layoutType: NavigationSuiteType,
    navigationSuiteColors: NavigationSuiteColors = NavigationSuiteDefaults.colors(),
    state: NavigationSuiteScaffoldState = rememberNavigationSuiteScaffoldState(),
    content: @Composable () -> Unit = {}
): Unit

XR-specific Navigation Suite Scaffold that wraps its content in a SpatialPanel.

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.

Parameters
navigationSuiteItems: NavigationSuiteScope.() -> Unit

the navigation items to be displayed
modifier: SubspaceModifier

the SubspaceModifier to be applied to the navigation suite scaffold
layoutType: NavigationSuiteType

the current 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
state: NavigationSuiteScaffoldState = rememberNavigationSuiteScaffoldState()

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

the content of your screen