PaneExpansionAnchor

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 abstract val description: String

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

Members

Proportion

class Proportion(@FloatRange(0.0, 1.0) 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

override val description

description

override val CompositionLocalConsumerModifierNode.description: String

Functions

positionIn

override fun positionIn(totalSizePx: Int, density: Density) =
            (totalSizePx * proportion).roundToInt().coerceIn(0, totalSizePx)

toString

override fun toString(): String

equals

override fun equals(other: Any?): Boolean

hashCode

override fun hashCode(): Int

Offset

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

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

Properties

direction

val direction: Direction = Direction(type)

Indicates the direction of the offset.

Functions

toString

override fun toString(): String

equals

override fun equals(other: Any?): Boolean

hashCode

override fun hashCode(): Int

Members

Direction

class Direction internal constructor(internal val value: Int)

Represents the direction from where the offset will be calculated.

Members

Companion

companion object

Properties

FromStart

val FromStart = 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

val FromEnd = 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

companion object

Functions

fromStart

fun fromStart(offset: Dp): Offset

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

Parameters

fromEnd

fun fromEnd(offset: Dp): Offset

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

Parameters