ThreePaneScaffoldState

ThreePaneScaffoldState(initialScaffoldValue: ThreePaneScaffoldValue)

Constructs a ThreePaneScaffoldState with an initial value of initialScaffoldValue.

suspend fun animateTo(
    targetState: ThreePaneScaffoldValue = this.targetState,
    animationSpec: FiniteAnimationSpec<Float>? = null
): Unit

Updates the current targetState to targetState with an animation to the new state.

suspend fun seekTo(
    fraction: @FloatRange(from = 0.0, to = 1.0) Float,
    targetState: ThreePaneScaffoldValue = this.targetState
): Unit

Seeks the transition to targetState with fraction used to indicate the progress towards targetState.

suspend fun snapTo(targetState: ThreePaneScaffoldValue): Unit

Sets currentState and targetState to targetState and snaps all values to those at that state. The transition will not have any animations running after running snapTo.

val currentState: ThreePaneScaffoldValue

Current ThreePaneScaffoldValue state of the transition. If there is an active transition, currentState and targetState are different.

val progressFraction: Float

The progress of the transition from currentState to targetState as a fraction of the entire duration.

If targetState and currentState are the same, progressFraction will be 0.

val targetState: ThreePaneScaffoldValue

Target ThreePaneScaffoldValue state of the transition. If this is the same as currentState, no transition is active.

@ExperimentalMaterial3AdaptiveApi
@Composable
fun ThreePaneScaffoldState.calculateListDetailPaneScaffoldMotion(): ThreePaneMotion

Calculates the default ThreePaneMotion of ListDetailPaneScaffold according to the given ThreePaneScaffoldState's current and target values.

@ExperimentalMaterial3AdaptiveApi
@Composable
fun ThreePaneScaffoldState.calculateSupportingPaneScaffoldMotion(): ThreePaneMotion

Calculates the default ThreePaneMotion of SupportingPaneScaffold according to the given ThreePaneScaffoldState's current and target values.