Known direct subclasses
ExtendedPaneScaffoldPaneScope

Extended scope for the panes of pane scaffolds.

ThreePaneScaffoldScope

Scope for the panes of ThreePaneScaffold.

Known indirect subclasses

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.

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

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

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
From androidx.compose.material3.adaptive.layout.PaneScaffoldTransitionScope
open EnterTransition

A convenient function to get the given PaneMotion's EnterTransition under the context of the current PaneScaffoldTransitionScope.

Cmn
open ExitTransition

A convenient function to get the given PaneMotion's EnterTransition under the context of the current PaneScaffoldTransitionScope.

Cmn
PaneScaffoldMotionDataProvider<Role>

Provides measurement and other data required in motion calculation like the size and offset of each pane before and after the motion.

Cmn
Float

The current motion progress.

Cmn
Transition<ScaffoldValue>

The current scaffold state transition between PaneScaffoldValues.

Cmn