Start native apps faster with the Composables CLI ->
Interface

PaneAdaptedValue

The adapted state of a pane.

Source set: Common
sealed interface PaneAdaptedValue

The adapted state of a pane. It gives clues to pane scaffolds about if a certain pane should be composed and how.

Members

Reflowed

Source set: Common
class Reflowed(internal val reflowUnder: PaneScaffoldRole) : PaneAdaptedValue

Indicates that the associated pane should be reflowed to its reflowUnder, i.e., it will be displayed under the target pane.

Parameters
reflowUnder the target pane of the reflowing, i.e., the pane that the reflowed pane will be put under.

Functions

toString

Source set: Common
override fun toString() = "PaneAdaptedValue[Reflowed to $reflowUnder]"

equals

Source set: Common
override fun equals(other: Any?): Boolean

hashCode

Source set: Common
override fun hashCode(): Int

Levitated

Source set: Common
class Levitated(
        internal val alignment: Alignment,
        internal val scrim: (@Composable () -> Unit)? = null,
        internal val dragToResizeState: DragToResizeState? = null,
    ) : PaneAdaptedValue

Indicates that the associated pane should be levitated with the specified alignment.

Parameters
alignment the alignment of the levitated pane relative to the pane scaffold; the alignment can also be provided as anchoring to a certain alignment line or a certain element in the window. See Alignment for more information.
scrim the scrim to show when the levitated pane is shown to block user interaction with the underlying layout and emphasize the levitated pane; by default it will be null and no scrim will show; to display a scrim, we recommend to use LevitatedPaneScrim as a default implementation.
dragToResizeState the optional state to enable the levitated pane to be resizable by dragging; it will be used to store and control current dragging; see rememberDragToResizeState for more details about how to implement the drag-to-resize behavior.

Functions

toString

Source set: Common
override fun toString() = "PaneAdaptedValue[Levitated with $alignment and scrim=$scrim]"

equals

Source set: Common
override fun equals(other: Any?): Boolean

hashCode

Source set: Common
override fun hashCode(): Int

Companion

Source set: Common
companion object

Properties

Expanded

Source set: Common
val Expanded: PaneAdaptedValue = Simple("Expanded")

Indicates that the associated pane should be displayed in its full width and height.

Hidden

Source set: Common
val Hidden: PaneAdaptedValue = Simple("Hidden")

Indicates that the associated pane should be hidden.