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
Cmn

Public properties
abstract ThreePaneScaffoldValue

Current ThreePaneScaffoldValue state of the transition.
Cmn
abstract Boolean

Whether a predictive back navigation is currently in progress.
Cmn
abstract Float

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

Target ThreePaneScaffoldValue state of the transition.
Cmn

Protected constructors

ThreePaneScaffoldState

Cmn 
protected ThreePaneScaffoldState()

Public properties

currentState

Cmn
Added in 1.1.0
abstract val currentState: ThreePaneScaffoldValue

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

isPredictiveBackInProgress

Cmn
Added in 1.1.0
abstract val isPredictiveBackInProgress: Boolean

Whether a predictive back navigation is currently in progress.

progressFraction

Cmn
Added in 1.1.0
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.

targetState

Cmn
Added in 1.1.0
abstract val targetState: ThreePaneScaffoldValue

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