ThreePaneScaffoldState

Cmn

@ExperimentalMaterial3AdaptiveApi
sealed class ThreePaneScaffoldState

Known direct subclasses

MutableThreePaneScaffoldState

The seekable state of a three pane scaffold.

A read-only state of a three pane scaffold. It provides information about the Transition between ThreePaneScaffoldValues.

Summary

Protected constructors
`ThreePaneScaffoldState()`	Cmn

Public properties
`abstract ThreePaneScaffoldValue`	`currentState` Current `ThreePaneScaffoldValue` state of the transition.	Cmn
`abstract Float`	`progressFraction` The progress of the transition from `currentState` to `targetState` as a fraction of the entire duration.	Cmn
`abstract ThreePaneScaffoldValue`	`targetState` Target `ThreePaneScaffoldValue` state of the transition.	Cmn

Extension functions
`ThreePaneMotion`	`@ExperimentalMaterial3AdaptiveApi @Composable ThreePaneScaffoldState.calculateListDetailPaneScaffoldMotion()` Calculates the default `ThreePaneMotion` of `ListDetailPaneScaffold` according to the given `ThreePaneScaffoldState`'s current and target values.	Cmn
`ThreePaneMotion`	`@ExperimentalMaterial3AdaptiveApi @Composable ThreePaneScaffoldState.calculateSupportingPaneScaffoldMotion()` Calculates the default `ThreePaneMotion` of `SupportingPaneScaffold` according to the given `ThreePaneScaffoldState`'s current and target values.	Cmn

Cmn

protected ThreePaneScaffoldState()

Cmn

abstract val currentState: ThreePaneScaffoldValue

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

Cmn

abstract 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.

Cmn

abstract val targetState: ThreePaneScaffoldValue

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

Cmn

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

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

Cmn

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

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