ListDetailPaneScaffold

A Material opinionated implementation of ThreePaneScaffold that will display the provided three panes in a canonical list-detail layout.

Android
@ExperimentalMaterial3AdaptiveApi
@Composable
fun ListDetailPaneScaffold(
    listPane: @Composable ThreePaneScaffoldScope.() -> Unit,
    modifier: Modifier = Modifier,
    scaffoldState: ThreePaneScaffoldState = calculateListDetailPaneScaffoldState(),
    windowInsets: WindowInsets = ListDetailPaneScaffoldDefaults.windowInsets,
    extraPane: (@Composable ThreePaneScaffoldScope.() -> Unit)? = null,
    detailPane: @Composable ThreePaneScaffoldScope.() -> Unit
)

Parameters

listPane the list pane of the scaffold. See ListDetailPaneScaffoldRole.List.
modifier Modifier of the scaffold layout.
scaffoldState the state of the scaffold, which provides the current scaffold directive and scaffold value.
windowInsets window insets that the scaffold will respect.
extraPane the list pane of the scaffold. See ListDetailPaneScaffoldRole.Extra.
detailPane the list pane of the scaffold. See ListDetailPaneScaffoldRole.Detail.