# SpatialListDetailPaneScaffold

## Functions summary

|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `@https://developer.android.com/reference/kotlin/androidx/xr/compose/material3/ExperimentalMaterial3XrApi @https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable https://developer.android.com/reference/kotlin/androidx/xr/compose/material3/SpatialListDetailPaneScaffold.composable#SpatialListDetailPaneScaffold(kotlin.Function1,kotlin.Function1,androidx.xr.compose.subspace.layout.SubspaceModifier,androidx.xr.compose.subspace.layout.SpatialArrangement.Horizontal,kotlin.Function1)( listPane: @https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable @https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/SubspaceComposable https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/SpatialBoxScope.() -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html, detailPane: @https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable @https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/SubspaceComposable https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/SpatialBoxScope.() -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html, modifier: https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/layout/SubspaceModifier, horizontalArrangement: https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/layout/SpatialArrangement.Horizontal, extraPane: (@https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable @https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/SubspaceComposable https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/SpatialBoxScope.() -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)? )` An XR-differentiated version of a three pane layout that follows the Material guidelines, displaying the provided panes in a canonical [list-detail layout](https://m3.material.io/foundations/layout/canonical-layouts/list-detail). |

## Functions

### SpatialListDetailPaneScaffold

Artifact: [androidx.xr.compose.material3:material3](https://developer.android.com/jetpack/androidx/releases/xr-compose-material3) [View Source](https://cs.android.com/search?q=file:androidx/xr/compose/material3/ListDetailPaneScaffold.kt+function: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](https://m3.material.io/foundations/layout/canonical-layouts/list-detail).

| Parameters |
|---|---|
| `listPane: @https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable @https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/SubspaceComposable https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/SpatialBoxScope.() -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | 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: @https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable @https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/SubspaceComposable https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/SpatialBoxScope.() -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | 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: https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/layout/SubspaceModifier = SubspaceModifier` | `https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/layout/SubspaceModifier` of the surrounding spatial layout |
| `horizontalArrangement: https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/layout/SpatialArrangement.Horizontal = XrThreePaneScaffoldTokens.DefaultArrangement` | The horizontal arrangement of the children. |
| `extraPane: (@https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable @https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/SubspaceComposable https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/SpatialBoxScope.() -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)? = 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. |