{% setvar book_path %}/reference/androidx/_book.yaml{% endsetvar %} {% include "_shared/_reference-head-tags.html" %}

LazyListLayoutInfo

public interface LazyListLayoutInfo


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

Use LazyListState.layoutInfo to retrieve this

Summary

Public methods

default int

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

default int

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

default int

The spacing between items in the direction of scrolling.

default @NonNull Orientation

The orientation of the lazy list.

default boolean

True if the direction of scrolling and layout is reversed.

abstract int

The total count of items passed to LazyColumn or LazyRow.

abstract int

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

default @NonNull IntSize

The size of the viewport in pixels.

abstract int

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

abstract @NonNull List<@NonNull LazyListItemInfo>

The list of LazyListItemInfo representing all the currently visible items.

Public methods

getAfterContentPadding

default int getAfterContentPadding()

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.

getBeforeContentPadding

default int getBeforeContentPadding()

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.

getMainAxisItemSpacing

default int getMainAxisItemSpacing()

The spacing between items in the direction of scrolling.

getOrientation

default @NonNull Orientation getOrientation()

The orientation of the lazy list.

getReverseLayout

default boolean getReverseLayout()

True if the direction of scrolling and layout is reversed.

getTotalItemsCount

abstract int getTotalItemsCount()

The total count of items passed to LazyColumn or LazyRow.

getViewportEndOffset

abstract int getViewportEndOffset()

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.

getViewportSize

default @NonNull IntSize getViewportSize()

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

getViewportStartOffset

abstract int getViewportStartOffset()

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.

getVisibleItemsInfo

abstract @NonNull List<@NonNull LazyListItemInfogetVisibleItemsInfo()

The list of LazyListItemInfo representing all the currently visible items.