Class

ThreePaneScaffoldState

A read-only state of a three pane scaffold.

RevenueCat

RevenueCat

Add subscriptions to your apps in minutes

Ad Get started for free
Common
@ExperimentalMaterial3AdaptiveApi
sealed class ThreePaneScaffoldState

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

Properties

Common
abstract val currentState: ThreePaneScaffoldValue

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

Common
abstract val targetState: ThreePaneScaffoldValue

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

Common
@get:FloatRange(from = 0.0, to = 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.

Common
abstract val isPredictiveBackInProgress: Boolean

Whether a predictive back navigation is currently in progress.