ThreePaneScaffold

Functions summary

Unit
@ExperimentalMaterial3XrApi
@Composable
ThreePaneScaffold(
    modifier: SubspaceModifier,
    scaffoldDirective: PaneScaffoldDirective,
    paneOrder: ThreePaneScaffoldHorizontalOrder,
    secondaryPane: @Composable () -> Unit,
    tertiaryPane: (@Composable () -> Unit)?,
    primaryPane: @Composable () -> Unit
)

A pane scaffold composable that can display up to three panes in the order that ThreePaneScaffoldHorizontalOrder specifies, and allocate margins and spacers according to PaneScaffoldDirective.

Functions

ThreePaneScaffold

@ExperimentalMaterial3XrApi
@Composable
fun ThreePaneScaffold(
    modifier: SubspaceModifier,
    scaffoldDirective: PaneScaffoldDirective,
    paneOrder: ThreePaneScaffoldHorizontalOrder,
    secondaryPane: @Composable () -> Unit,
    tertiaryPane: (@Composable () -> Unit)? = null,
    primaryPane: @Composable () -> Unit
): Unit

A pane scaffold composable that can display up to three panes in the order that ThreePaneScaffoldHorizontalOrder specifies, and allocate margins and spacers according to PaneScaffoldDirective.

ThreePaneScaffold is the base composable functions of adaptive programming. Developers can freely pipeline the relevant adaptive signals and use them as input of the scaffold function to render the final adaptive layout.

Parameters
modifier: SubspaceModifier

The modifier to be applied to the layout.
scaffoldDirective: PaneScaffoldDirective

The top-level directives about how the scaffold should arrange its panes.
paneOrder: ThreePaneScaffoldHorizontalOrder

The horizontal order of the panes from start to end in the scaffold.
secondaryPane: @Composable () -> Unit

The content of the secondary pane that has a priority lower then the primary pane but higher than the tertiary pane.
tertiaryPane: (@Composable () -> Unit)? = null

The content of the tertiary pane that has the lowest priority.
primaryPane: @Composable () -> Unit

The content of the primary pane that has the highest priority.