ThreePaneScaffoldScope

Artifact: androidx.compose.material3.adaptive:adaptive-layout

View Source

Added in 1.0.0

Common/All

• Cmn

  @ExperimentalMaterial3AdaptiveApi
  sealed interface ThreePaneScaffoldScope : ExtendedPaneScaffoldScope

Known direct subclasses

ThreePaneScaffoldPaneScope

ThreePaneScaffoldPaneScope

Scope for the panes of ThreePaneScaffold.

---

Scope for the panes of ThreePaneScaffold.

Summary

Extension functions
Unit	@ExperimentalMaterial3AdaptiveApi @Composable ThreePaneScaffoldScope.PaneExpansionDragHandle(     state: PaneExpansionState,     color: Color,     modifier: Modifier ) A default, basic non-customizable implementation of pane expansion drag handle.	Cmn

Inherited functions
From androidx.compose.ui.layout.LookaheadScope open Offset LayoutCoordinates.localLookaheadPositionOf(     sourceCoordinates: LayoutCoordinates,     relativeToSource: Offset,     includeMotionFrameOfReference: Boolean ) Converts relativeToSource in sourceCoordinates's lookahead coordinate space into local lookahead coordinates. Cmn LayoutCoordinates LayoutCoordinates.toLookaheadCoordinates() Converts a LayoutCoordinates into a LayoutCoordinates in the Lookahead coordinate space. Cmn
From androidx.compose.material3.adaptive.layout.PaneScaffoldScope Modifier Modifier.preferredWidth(width: Dp) This modifier specifies the preferred width for a pane, and the pane scaffold implementation will try its best to respect this width when the associated pane is rendered as a fixed pane, i.e., a pane that are not stretching to fill the remaining spaces. Cmn

Inherited properties
From androidx.compose.ui.layout.LookaheadScope LayoutCoordinates Placeable.PlacementScope.lookaheadScopeCoordinates Returns the LayoutCoordinates of the LookaheadScope. Cmn
From androidx.compose.material3.adaptive.layout.PaneScaffoldMotionScope FiniteAnimationSpec<IntOffset> delayedPositionAnimationSpec The delayed position animation spec of the associated pane to the scope. Cmn List<PaneMotionData> paneMotionDataList PaneMotionData of all panes in the scaffold corresponding to the scaffold's current state transition and motion settings, listed in panes' horizontal order. Cmn FiniteAnimationSpec<IntOffset> positionAnimationSpec The position animation spec of the associated pane to the scope. Cmn IntSize scaffoldSize The scaffold's current size. Cmn FiniteAnimationSpec<IntSize> sizeAnimationSpec The size animation spec of the associated pane to the scope. Cmn
From androidx.compose.material3.adaptive.layout.PaneScaffoldTransitionScope Float motionProgress The current motion progress. Cmn Transition<ThreePaneScaffoldValue> scaffoldStateTransition The current scaffold state transition between PaneScaffoldValues. Cmn

Extension functions

PaneExpansionDragHandle

Cmn

Artifact: androidx.compose.material3.adaptive:adaptive-layout

View Source

@ExperimentalMaterial3AdaptiveApi
@Composable
fun ThreePaneScaffoldScope.PaneExpansionDragHandle(
    state: PaneExpansionState,
    color: Color,
    modifier: Modifier = Modifier
): Unit

A default, basic non-customizable implementation of pane expansion drag handle. Note that this implementation will be deprecated in favor of the corresponding Material3 implementation when it's available.