PaneExpansionAnchor

public sealed class PaneExpansionAnchor

The implementations of this interface represent different types of anchors of pane expansion dragging. Setting up anchors when create PaneExpansionState will force user dragging to snap to the set anchors after user releases the drag.

Properties

description

@get:Composable public abstract val description: String

The description of the anchor that will be used in androidx.compose.ui.semantics.SemanticsProperties like accessibility services.

Members

Proportion

public class Proportion(@FloatRange(0.0, 1.0) public val proportion: Float) :
        PaneExpansionAnchor()

PaneExpansionAnchor implementation that specifies the anchor position in the proportion of the total size of the layout at the start side of the anchor.

Parameters

Properties

type

override val type = ProportionType

description

public override val description: String

description

override val CompositionLocalConsumerModifierNode.description: String

Offset

public abstract class Offset internal constructor(public val offset: Dp, override internal val type: Int) :
        PaneExpansionAnchor()

PaneExpansionAnchor implementation that specifies the anchor position based on the offset in Dp.

Properties

direction

public val direction: Direction = Direction(type)

Indicates the direction of the offset.

Members

Direction

public class Direction internal constructor(internal val value: Int)

Represents the direction from where the offset will be calculated.

Members

Companion

public companion object

Properties

FromStart

public val FromStart: Direction = Direction(OffsetFromStartType)

Indicates the offset will be calculated from the start. For example, if the offset is 150.dp, the resulted anchor will be at the position that is 150dp away from the start side of the associated layout.

FromEnd

public val FromEnd: Direction = Direction(OffsetFromEndType)

Indicates the offset will be calculated from the end. For example, if the offset is 150.dp, the resulted anchor will be at the position that is 150dp away from the end side of the associated layout.

Companion

public companion object

Functions

fromStart

public fun fromStart(offset: Dp): Offset

Create an androidx.compose.material3.adaptive.layout.PaneExpansionAnchor.Offset anchor from the start side of the layout.

Parameters

fromEnd

public fun fromEnd(offset: Dp): Offset

Create an androidx.compose.material3.adaptive.layout.PaneExpansionAnchor.Offset anchor from the end side of the layout.

Parameters