core/com.composables.core/ScrollAreaState

ScrollAreaState

interface ScrollAreaState

Defines how to scroll the scrollable component and how to display a scrollbar for it.

The values of this interface are typically in pixels, but do not have to be. It's possible to create an adapter with any scroll range of Double values.

Properties

Link copied to clipboard
abstract val contentSize: Double

The size of the scrollable content, on the scrollable axis.

Link copied to clipboard
Link copied to clipboard
val ScrollAreaState.maxScrollOffset: Double

The maximum scroll offset of the scrollable content.

Link copied to clipboard
abstract val scrollOffset: Double

Scroll offset of the content inside the scrollable component.

Link copied to clipboard
abstract val viewportSize: Double

The size of the viewport, on the scrollable axis.

Functions

Link copied to clipboard
abstract suspend fun scrollTo(scrollOffset: Double)

Instantly jump to scrollOffset.