ListState

public class ListState(firstVisibleItemIndex: Int = 0, firstVisibleItemScrollOffset: Int = 0) :
    ScrollableState

A state object that can be hoisted to control and observe scrolling.

In most cases, this will be created via rememberListState.

Parameters

Properties

firstVisibleItemIndex

public val firstVisibleItemIndex: Int

The index of the first item that is visible within the scrollable viewport area not including items in the content padding region. For the first visible item that includes items in the content padding please use ListLayoutInfo.visibleItemsInfo.

Note that this property is observable and if you use it in the composable function it will be recomposed on every change causing potential performance issues.

firstVisibleItemScrollOffset

public val firstVisibleItemScrollOffset: Int

The scroll offset of the first visible item. Scrolling forward is positive - i.e., the amount that the item is offset backwards.

Note that this property is observable and if you use it in the composable function it will be recomposed on every scroll causing potential performance issues.

layoutInfo

public val layoutInfo: ListLayoutInfo

The object of ListLayoutInfo calculated during the last layout pass. For example, you can use it to calculate what items are currently visible.

Note that this property is observable and is updated after every scroll or remeasure. If you use it in the composable function it will be recomposed on every change causing potential performance issues including infinity recomposition loop. Therefore, avoid using it in the composition.

If you want to run some side effects like sending an analytics event or updating a state based on this value consider using "snapshotFlow":

interactionSource

public val interactionSource: InteractionSource

InteractionSource that will be used to dispatch drag events when this list is being dragged. If you want to know whether the fling (or animated scroll) is in progress, use isScrollInProgress.

Functions

scrollToItem

public suspend fun scrollToItem(@IntRange(from = 0) index: Int, scrollOffset: Int = 0)

Instantly brings the item at index to the top of the viewport, offset by scrollOffset pixels.

Parameters

animateScrollToItem

public suspend fun animateScrollToItem(@IntRange(from = 0) index: Int, scrollOffset: Int = 0)

Animate (smooth scroll) to the given item.

Parameters

Companion Object

Properties

public val Saver: Saver<ListState, Any>

The default Saver implementation for ListState.