class LazyColumnState : ScrollableState

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

In most cases, this will be created via rememberLazyColumnState.

Summary

Public constructors

Public functions
open Float
open suspend Unit
scroll(scrollPriority: MutatePriority, block: suspend ScrollScope.() -> Unit)

Public properties
open Boolean
open Boolean
open Boolean
LazyColumnLayoutInfo

The object of LazyColumnLayoutInfo calculated during the last layout pass.

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

Public constructors

LazyColumnState

Added in 1.5.0-alpha03
LazyColumnState()

Public functions

dispatchRawDelta

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

scroll

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

Public properties

canScrollBackward

open val canScrollBackward: Boolean

canScrollForward

open val canScrollForward: Boolean

isScrollInProgress

Added in 1.5.0-alpha03
open val isScrollInProgress: Boolean

layoutInfo

Added in 1.5.0-alpha03
val layoutInfo: LazyColumnLayoutInfo

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":