Indicate the associated pane should be levitated when certain conditions are met. With the default calculation functions calculateThreePaneScaffoldValue we provide. A pane with a levitate strategy will be adapted to either:

  1. PaneAdaptedValue.Levitated with specified alignment, when the levitated pane is the current destination, and the provided Strategy is Strategy.Always or it's a single-pane layout;

  2. PaneAdaptedValue.Expanded, when the levitated pane is one of the most recent destinations, and the provided Strategy is Strategy.SinglePaneOnly and it's not a single-pane layout; or

  3. PaneAdaptedValue.Hidden otherwise.

Summary

Nested types

The strategy that specifies when the associated pane should be levitated.

Public constructors
Cmn

Public functions
open operator Boolean
equals(other: Any?)
Cmn
open Int
Cmn
open String
Cmn

Public properties
Alignment

the alignment of the associated pane when it's levitated, relatively to the pane scaffold.
Cmn
AdaptStrategy.Levitate.Strategy

the strategy that specifies when the associated pane should be levitated; see Strategy for more detailed descriptions.
Cmn

Inherited functions
From androidx.compose.material3.adaptive.layout.AdaptStrategy
open PaneAdaptedValue

This function is deprecated. This function is deprecated in favor of directly using the info carried by the strategy instances to make adaptation decisions.
Cmn

Public constructors

Levitate

Cmn 
Levitate(
    strategy: AdaptStrategy.Levitate.Strategy = Strategy.Always,
    alignment: Alignment = Alignment.Center
)
Parameters
strategy: AdaptStrategy.Levitate.Strategy = Strategy.Always

the strategy that specifies when the associated pane should be levitated; see Strategy for more detailed descriptions.
alignment: Alignment = Alignment.Center

the alignment of the associated pane when it's levitated, relatively to the pane scaffold.

Public functions

equals

Cmn 
open operator fun equals(other: Any?): Boolean

hashCode

Cmn 
open fun hashCode(): Int

toString

Cmn 
open fun toString(): String

Public properties

alignment

Cmn
Added in 1.2.0-alpha05
val alignment: Alignment

the alignment of the associated pane when it's levitated, relatively to the pane scaffold.

strategy

Cmn
Added in 1.2.0-alpha05
val strategy: AdaptStrategy.Levitate.Strategy

the strategy that specifies when the associated pane should be levitated; see Strategy for more detailed descriptions.