TransformingLazyColumnState

class TransformingLazyColumnState : ScrollableState

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

In most cases, this will be created via rememberTransformingLazyColumnState.

Summary

Public constructors

Public functions
suspend Unit
animateScrollToItem(index: @IntRange(from = 0) Int, scrollOffset: Int)

Animate (smooth scroll) to the given item.
open Float
Unit
requestScrollToItem(index: @IntRange(from = 0) Int, scrollOffset: Int)

Requests the item at index to be at the center of the viewport during the next remeasure, offset by scrollOffset.
open suspend Unit
scroll(scrollPriority: MutatePriority, block: suspend ScrollScope.() -> Unit)
suspend Unit
scrollToItem(index: @IntRange(from = 0) Int, scrollOffset: Int)

Scrolls the item specified by index to the center of the screen.

Public properties
open Boolean
open Boolean
open Boolean
TransformingLazyColumnLayoutInfo

The object of LazyColumnLayoutInfo calculated during the last layout pass.

Inherited properties
From androidx.compose.foundation.gestures.ScrollableState
open Boolean
open Boolean

Public constructors

TransformingLazyColumnState

Added in 1.5.0-alpha06
TransformingLazyColumnState()

Public functions

animateScrollToItem

Added in 1.5.0-alpha06
suspend fun animateScrollToItem(index: @IntRange(from = 0) Int, scrollOffset: Int = 0): Unit

Animate (smooth scroll) to the given item.

Parameters
index: @IntRange(from = 0) Int

the index to which to scroll. Must be non-negative.
scrollOffset: Int = 0

The offset between the center of the screen and item's center. Positive offset means the item will be scrolled up.

dispatchRawDelta

Added in 1.5.0-alpha06
open fun dispatchRawDelta(delta: Float): Float

requestScrollToItem

Added in 1.5.0-alpha06
fun requestScrollToItem(index: @IntRange(from = 0) Int, scrollOffset: Int = 0): Unit

Requests the item at index to be at the center of the viewport during the next remeasure, offset by scrollOffset.

The scroll position will be updated to the requested position rather than maintain the index based on the center item key (when a data set change will also be applied during the next remeasure), but only for the next remeasure.

Any scroll in progress will be cancelled.

Parameters
index: @IntRange(from = 0) Int

the index to which to scroll. Must be non-negative.
scrollOffset: Int = 0

The offset between the center of the screen and item's center. Positive offset means the item will be scrolled up.

scroll

Added in 1.5.0-alpha06
open suspend fun scroll(scrollPriority: MutatePriority, block: suspend ScrollScope.() -> Unit): Unit

scrollToItem

Added in 1.5.0-alpha06
suspend fun scrollToItem(index: @IntRange(from = 0) Int, scrollOffset: Int = 0): Unit

Scrolls the item specified by index to the center of the screen.

This operation happens instantly without animation.

Parameters
index: @IntRange(from = 0) Int

The index of the item to scroll to. Must be non-negative.
scrollOffset: Int = 0

The offset between the center of the screen and item's center. Positive offset means the item will be scrolled up.

Public properties

canScrollBackward

open val canScrollBackward: Boolean

canScrollForward

open val canScrollForward: Boolean

isScrollInProgress

Added in 1.5.0-alpha06
open val isScrollInProgress: Boolean

layoutInfo

Added in 1.5.0-alpha06
val layoutInfo: TransformingLazyColumnLayoutInfo

The object of LazyColumnLayoutInfo 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":