LazyLayoutAnimateScrollScope

A scope to allow customization of animated scroll in LazyLayouts. This scope contains all needed information to perform an animatedScroll in a scrollable LazyLayout.

For implementations for the most common layouts see:

See also
LazyLayoutAnimateScrollScope
LazyLayoutAnimateScrollScope
LazyLayoutAnimateScrollScope
LazyLayoutAnimateScrollScope

Summary

Public functions
Int
calculateDistanceTo(targetIndex: Int, targetOffset: Int)

The "expected" distance to targetIndex.
Cmn
Unit
ScrollScope.snapToItem(index: Int, offset: Int)

Immediately scroll to index and settle in offset.
Cmn

Public properties
Int

The index of the first visible item in the lazy layout.
Cmn
Int

The offset of the first visible item.
Cmn
Int

The total item count.
Cmn
Int

The last visible item in the LazyLayout, lastVisibleItemIndex - firstVisibleItemOffset + 1 is the number of visible items.
Cmn

Public functions

calculateDistanceTo

Cmn
Added in 1.8.0-alpha01
fun calculateDistanceTo(targetIndex: Int, targetOffset: Int = 0): Int

The "expected" distance to targetIndex. This means the "expected" offset of targetIndex in the layout. In a LazyLayout, non-visible items don't have an actual offset, so this method should return an approximation of the scroll offset to targetIndex. If targetIndex is visible, then an "exact" offset should be provided.

Parameters
targetIndex: Int

The index position with respect to which this calculation should be done.
targetOffset: Int = 0

The offset with respect to which this calculation should be done.
Returns
Int

The expected distance to scroll so targetIndex is the firstVisibleItemIndex with targetOffset as the firstVisibleItemScrollOffset.

snapToItem

Cmn 
fun ScrollScope.snapToItem(index: Int, offset: Int = 0): Unit

Immediately scroll to index and settle in offset.

Parameters
index: Int

The position index where we should immediately snap to.
offset: Int = 0

The offset where we should immediately snap to.

Public properties

firstVisibleItemIndex

Cmn
Added in 1.8.0-alpha01
val firstVisibleItemIndex: Int

The index of the first visible item in the lazy layout.

firstVisibleItemScrollOffset

Cmn
Added in 1.8.0-alpha01
val firstVisibleItemScrollOffset: Int

The offset of the first visible item.

itemCount

Cmn
Added in 1.8.0-alpha01
val itemCount: Int

The total item count.

lastVisibleItemIndex

Cmn
Added in 1.8.0-alpha01
val lastVisibleItemIndex: Int

The last visible item in the LazyLayout, lastVisibleItemIndex - firstVisibleItemOffset + 1 is the number of visible items.