LazyLayoutScrollScope
-
Cmn
interface LazyLayoutScrollScope : ScrollScope
A ScrollScope to allow customization of scroll sessions in LazyLayouts. This scope contains additional information to perform a custom scroll session in a scrollable LazyLayout.
For implementations for the most common layouts see:
Summary
Public functions |
||
|---|---|---|
Int |
calculateDistanceTo(targetIndex: Int, targetOffset: Int)The "expected" distance to |
Cmn
|
Unit |
snapToItem(index: Int, offset: Int) |
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
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 |
Public properties
firstVisibleItemIndex
val firstVisibleItemIndex: Int
The index of the first visible item in the lazy layout.
firstVisibleItemScrollOffset
val firstVisibleItemScrollOffset: Int
The offset of the first visible item.
lastVisibleItemIndex
val lastVisibleItemIndex: Int
The last visible item in the LazyLayout, lastVisibleItemIndex - firstVisibleItemOffset + 1 is the number of visible items.