TransformingLazyColumnItemScrollProgress

public value class TransformingLazyColumnItemScrollProgress
internal constructor(private val packedValue: Long)

Scroll progress of an item in a TransformingLazyColumn before any modifications to the item's height are applied (using TransformingLazyColumnItemScope.transformedHeight modifier).

Secondary Constructors

public constructor(
    topOffsetFraction: Float,
    bottomOffsetFraction: Float,
) : this(packFloats(topOffsetFraction, bottomOffsetFraction))

Constructs a TransformingLazyColumnItemScrollProgress with two offset fraction Float values.

Parameters

Properties

topOffsetFraction

public val topOffsetFraction: Float

The top offset (between the top of the list container and the top of the item) as a fraction of the height of the list container. Is within (0, 1) when item is inside the screen and could be negative if the top of the item is off the screen. Value is calculated from the top of the container. This value is calculated before any height modifications are applied (using TransformingLazyColumnItemScope.transformedHeight modifier). This returns Float.NaN if the progress was Unspecified.

bottomOffsetFraction

public val bottomOffsetFraction: Float

The bottom offset (between the top of the list container and the bottom of the item) as a fraction of the height of the list container. Is within (0, 1) when item is inside the screen and could exceed 1 when the bottom of item is off the screen. Value is calculated from the top of the container. This value is calculated before any height modifications are applied (using TransformingLazyColumnItemScope.transformedHeight modifier). This returns Float.NaN if the progress was Unspecified.

isUnspecified

public val isUnspecified: Boolean

true when this is TransformingLazyColumnItemScrollProgress.Unspecified.

isSpecified

public val isSpecified: Boolean

false when this is TransformingLazyColumnItemScrollProgress.Unspecified.

Companion Object

Properties

public val Unspecified: TransformingLazyColumnItemScrollProgress

Represents an unspecified TransformingLazyColumnItemScrollProgress value, usually a replacement for null when a primitive value is desired.