Compose Component

SupportingPaneScaffold

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

SupportingPaneScaffold

Source set: Android
@Composable
fun SupportingPaneScaffold(
    supportingPane: @Composable ThreePaneScaffoldScope.() -> Unit,
    modifier: Modifier = Modifier,
    scaffoldState: ThreePaneScaffoldState = calculateSupportingPaneScaffoldState(),
    windowInsets: WindowInsets = SupportingPaneScaffoldDefaults.windowInsets,
    extraPane: (@Composable ThreePaneScaffoldScope.() -> Unit)? = null,
    mainPane: @Composable ThreePaneScaffoldScope.() -> Unit
)

Parameters

supportingPane the supporting pane of the scaffold. See SupportingPaneScaffoldRole.Supporting.
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 extra pane of the scaffold. See SupportingPaneScaffoldRole.Extra.
mainPane the main pane of the scaffold. See SupportingPaneScaffoldRole.Main.
Jetpack Compose beyond MaterialFree components, screens and templates for apps that don’t look like Google’s. Copy them into your app, or let your coding agent add them.Browse for free

Content updated: