ThreePaneScaffoldValue

Artifact: androidx.compose.material3.adaptive:adaptive-layout

Added in 1.0.0

Cmn

@ExperimentalMaterial3AdaptiveApi
class ThreePaneScaffoldValue : PaneScaffoldValue, PaneExpansionStateKeyProvider

The adapted value of ThreePaneScaffold. It contains each pane's adapted value. ThreePaneScaffold will use the adapted values to decide which panes should be displayed and how they should be displayed. With other input parameters of ThreePaneScaffold fixed, each possible instance of this class should represent a unique state of ThreePaneScaffold and developers can compare two ThreePaneScaffoldValue to decide if there is a layout structure change.

For a Material-opinionated layout, it's suggested to use calculateThreePaneScaffoldValue to calculate the current scaffold value.

Summary

Public constructors
`ThreePaneScaffoldValue( primary: PaneAdaptedValue, secondary: PaneAdaptedValue, tertiary: PaneAdaptedValue )` create an instance of `ThreePaneScaffoldValue`	Cmn

Public functions
`open operator Boolean`	`equals(other: Any?)`	Cmn
`open operator PaneAdaptedValue`	`get(role: ThreePaneScaffoldRole)` Returns the `PaneAdaptedValue` of the given `role` of a pane.	Cmn
`open Int`	`hashCode()`	Cmn
`open String`	`toString()`	Cmn

Public properties
`open PaneExpansionStateKey`	`paneExpansionStateKey` The key that represents the unique state of the provider to index `PaneExpansionState`.	Cmn
`PaneAdaptedValue`	`primary` `PaneAdaptedValue` of the primary pane of `ThreePaneScaffold`	Cmn
`PaneAdaptedValue`	`secondary` `PaneAdaptedValue` of the secondary pane of `ThreePaneScaffold`	Cmn
`PaneAdaptedValue`	`tertiary` `PaneAdaptedValue` of the tertiary pane of `ThreePaneScaffold`	Cmn

Public constructors