SpatialListDetailPaneScaffold

Functions summary

Unit

An XR-differentiated version of a three pane layout that follows the Material guidelines, displaying the provided panes in a canonical list-detail layout.

Functions

SpatialListDetailPaneScaffold

@ExperimentalMaterial3XrApi
@Composable
fun SpatialListDetailPaneScaffold(
    listPane: @Composable @SubspaceComposable SpatialBoxScope.() -> Unit,
    detailPane: @Composable @SubspaceComposable SpatialBoxScope.() -> Unit,
    modifier: SubspaceModifier = SubspaceModifier,
    horizontalArrangement: SpatialArrangement.Horizontal = XrThreePaneScaffoldTokens.DefaultArrangement,
    extraPane: (@Composable @SubspaceComposable SpatialBoxScope.() -> Unit)? = null
): Unit

An XR-differentiated version of a three pane layout that follows the Material guidelines, displaying the provided panes in a canonical list-detail layout.

Parameters
listPane: @Composable @SubspaceComposable SpatialBoxScope.() -> Unit

the list pane of the scaffold, which is supposed to hold a list of item summaries that can be selected from, for example, the inbox mail list of a mail app. Note that we suggest you to use SpatialPanel as the root layout of panes, which supports default pane behaviors like enter/exit transitions.

detailPane: @Composable @SubspaceComposable SpatialBoxScope.() -> Unit

the detail pane of the scaffold, which is supposed to hold the detailed info of a selected item, for example, the mail content currently being viewed. Note that we suggest you to use SpatialPanel as the root layout of panes, which supports default pane behaviors like enter/exit transitions.

modifier: SubspaceModifier = SubspaceModifier

SubspaceModifier of the surrounding spatial layout

horizontalArrangement: SpatialArrangement.Horizontal = XrThreePaneScaffoldTokens.DefaultArrangement

The horizontal arrangement of the children.

extraPane: (@Composable @SubspaceComposable SpatialBoxScope.() -> Unit)? = null

the extra pane of the scaffold, which is supposed to hold any supplementary info besides the list and the detail panes, for example, a task list or a mini-calendar view of a mail app. Note that we suggest you to use SpatialPanel as the root layout of panes, which supports default pane behaviors like enter/exit transitions.