ThreePaneScaffoldOverrideContext
Parameters available to ThreePaneScaffold.
Summary
Public properties |
||
|---|---|---|
Modifier |
The modifier to be applied to the layout. |
Cmn
|
(@Composable (PaneExpansionState) -> Unit)? |
the pane expansion drag handle to allow users to drag to change pane expansion state, |
Cmn
|
PaneExpansionState |
the state object of pane expansion state. |
Cmn
|
ThreePaneScaffoldHorizontalOrder |
The horizontal order of the panes from start to end in the scaffold. |
Cmn
|
@Composable () -> Unit |
The content of the primary pane that has the highest priority. |
Cmn
|
PaneScaffoldDirective |
The top-level directives about how the scaffold should arrange its panes. |
Cmn
|
ThreePaneScaffoldState |
The current state of the scaffold, containing information about the adapted value of each pane of the scaffold and the transitions/animations in progress. |
Cmn
|
@Composable () -> Unit |
The content of the secondary pane that has a priority lower then the primary pane but higher than the tertiary pane. |
Cmn
|
(@Composable () -> Unit)? |
The content of the tertiary pane that has the lowest priority. |
Cmn
|
Public properties
paneExpansionDragHandle
val paneExpansionDragHandle: (@Composable (PaneExpansionState) -> Unit)?
the pane expansion drag handle to allow users to drag to change pane expansion state, null by default.
paneExpansionState
val paneExpansionState: PaneExpansionState
the state object of pane expansion state.
paneOrder
val paneOrder: ThreePaneScaffoldHorizontalOrder
The horizontal order of the panes from start to end in the scaffold.
primaryPane
val primaryPane: @Composable () -> Unit
The content of the primary pane that has the highest priority.
scaffoldDirective
val scaffoldDirective: PaneScaffoldDirective
The top-level directives about how the scaffold should arrange its panes.
scaffoldState
val scaffoldState: ThreePaneScaffoldState
The current state of the scaffold, containing information about the adapted value of each pane of the scaffold and the transitions/animations in progress.
secondaryPane
val 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
val tertiaryPane: (@Composable () -> Unit)?
The content of the tertiary pane that has the lowest priority.