TvLazyListLayoutInfo

sealed interface TvLazyListLayoutInfo


Contains useful information about the currently displayed layout state of lazy lists like TvLazyColumn or TvLazyRow. For example you can get the list of currently displayed item.

Use TvLazyListState.layoutInfo to retrieve this

Summary

Public properties

Int

The content padding in pixels applied after the last item in the direction of scrolling.

Int

The content padding in pixels applied before the first item in the direction of scrolling.

Int

The spacing between items in the direction of scrolling.

Orientation

The orientation of the lazy list.

Boolean

True if the direction of scrolling and layout is reversed.

Int

The total count of items passed to TvLazyColumn or TvLazyRow.

Int

The end offset of the layout's viewport in pixels.

IntSize

The size of the viewport in pixels.

Int

The start offset of the layout's viewport in pixels.

List<TvLazyListItemInfo>

The list of TvLazyListItemInfo representing all the currently visible items.

Public properties

afterContentPadding

Added in 1.0.0-alpha11
Deprecated in 1.0.0-alpha11
val afterContentPaddingInt

The content padding in pixels applied after the last item in the direction of scrolling. For example it is a bottom content padding for LazyColumn with reverseLayout set to false.

beforeContentPadding

Added in 1.0.0-alpha11
Deprecated in 1.0.0-alpha11
val beforeContentPaddingInt

The content padding in pixels applied before the first item in the direction of scrolling. For example it is a top content padding for LazyColumn with reverseLayout set to false.

mainAxisItemSpacing

Added in 1.0.0-alpha11
Deprecated in 1.0.0-alpha11
val mainAxisItemSpacingInt

The spacing between items in the direction of scrolling.

orientation

Added in 1.0.0-alpha11
Deprecated in 1.0.0-alpha11
val orientationOrientation

The orientation of the lazy list.

reverseLayout

Added in 1.0.0-alpha11
Deprecated in 1.0.0-alpha11
val reverseLayoutBoolean

True if the direction of scrolling and layout is reversed.

totalItemsCount

Added in 1.0.0-alpha11
Deprecated in 1.0.0-alpha11
val totalItemsCountInt

The total count of items passed to TvLazyColumn or TvLazyRow.

viewportEndOffset

Added in 1.0.0-alpha11
Deprecated in 1.0.0-alpha11
val viewportEndOffsetInt

The end offset of the layout's viewport in pixels. You can think of it as a maximum offset which would be visible. It is the size of the lazy list layout minus beforeContentPadding.

You can use it to understand what items from visibleItemsInfo are fully visible.

viewportSize

Added in 1.0.0-alpha11
Deprecated in 1.0.0-alpha11
val viewportSizeIntSize

The size of the viewport in pixels. It is the lazy list layout size including all the content paddings.

viewportStartOffset

Added in 1.0.0-alpha11
Deprecated in 1.0.0-alpha11
val viewportStartOffsetInt

The start offset of the layout's viewport in pixels. You can think of it as a minimum offset which would be visible. Usually it is 0, but it can be negative if non-zero beforeContentPadding was applied as the content displayed in the content padding area is still visible.

You can use it to understand what items from visibleItemsInfo are fully visible.

visibleItemsInfo

Added in 1.0.0-alpha11
Deprecated in 1.0.0-alpha11
val visibleItemsInfoList<TvLazyListItemInfo>

The list of TvLazyListItemInfo representing all the currently visible items.