DraggableAnchors

public interface DraggableAnchors<T>

Structure that represents the anchors of a AnchoredDraggableState.

See the DraggableAnchors factory method to construct drag anchors using a default implementation. This structure does not make any guarantees about ordering of the anchors.

Properties

size

public val size: Int

The number of anchors

Functions

positionOf

public fun positionOf(anchor: T): Float

Get the anchor position for an associated anchor

Parameters

Return

The position of the anchor, or Float.NaN if the anchor does not exist

hasPositionFor

public fun hasPositionFor(anchor: T): Boolean

Whether there is an anchor position associated with the anchor

Parameters

Return

true if there is an anchor for this value, false if there is no anchor for this value

closestAnchor

public fun closestAnchor(position: Float): T?

Find the closest anchor value to the position. If there are multiple anchors at the same offset, it is up to the implementation which will be returned. When using the DraggableAnchors factory function, this will be the last anchor of the candidates at this offset.

Parameters

Return

The closest anchor or null if the anchors are empty.

closestAnchor

public fun closestAnchor(position: Float, searchUpwards: Boolean): T?

Find the closest anchor value to the position, in the specified direction.

Parameters

Return

The closest anchor or null if the anchors are empty

minPosition

public fun minPosition(): Float

The smallest anchor position, or Float.NaN if the anchors are empty.

maxPosition

public fun maxPosition(): Float

The biggest anchor position, or Float.NaN if the anchors are empty.

anchorAt

public fun anchorAt(index: Int): T?

Get the anchor key at the specified index, or null if the index is out of bounds.

positionAt

public fun positionAt(index: Int): Float

Get the anchor position at the specified index, or Float.NaN if the index is out of bounds.