ExtendedPaneScaffoldScope

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

View Source

Added in 1.1.0-alpha07

Common/All

• Cmn

  @ExperimentalMaterial3AdaptiveApi
  sealed interface ExtendedPaneScaffoldScope<Role : Any?, ScaffoldValue : PaneScaffoldValue<Role>> : PaneScaffoldScope, PaneScaffoldMotionScope, PaneScaffoldTransitionScope, LookaheadScope

Known direct subclasses

ExtendedPaneScaffoldPaneScope, ThreePaneScaffoldScope

ExtendedPaneScaffoldPaneScope	Extended scope for the panes of pane scaffolds.
ThreePaneScaffoldScope	Scope for the panes of ThreePaneScaffold.

Known indirect subclasses

ThreePaneScaffoldPaneScope

ThreePaneScaffoldPaneScope

Scope for the panes of ThreePaneScaffold.

---

Extended scope for pane scaffolds. All pane scaffolds will implement this interface to provide necessary info for its sub-composables to correctly render their content, motion, etc.

Parameters
<Role : Any?>	The type of roles that denotes panes in the associated pane scaffold.
<ScaffoldValue : PaneScaffoldValue<Role>>	The type of scaffold values that denotes the PaneAdaptedValues in the associated pane scaffold.

See also
ThreePaneScaffoldScope
PaneScaffoldScope
PaneScaffoldMotionScope
PaneScaffoldTransitionScope
LookaheadScope

Summary

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 @ExperimentalMaterial3AdaptiveApi Modifier.paneExpansionDraggable(     state: PaneExpansionState,     minTouchTargetSize: Dp,     interactionSource: MutableInteractionSource ) The modifier that should be applied on a drag handle composable so the drag handle can be dragged and operate on the provided PaneExpansionState properly. Cmn 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 open EnterTransition PaneMotion.enterTransition A convenient function to get the given PaneMotion's EnterTransition under the context of the current PaneScaffoldMotionScope. Cmn open ExitTransition PaneMotion.exitTransition A convenient function to get the given PaneMotion's EnterTransition under the context of the current PaneScaffoldMotionScope. 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 IntSize scaffoldSize The scaffold's current size. Cmn
From androidx.compose.material3.adaptive.layout.PaneScaffoldTransitionScope Float motionProgress The current motion progress. Cmn Transition<ScaffoldValue> scaffoldStateTransition The current scaffold state transition between PaneScaffoldValues. Cmn