State of Compose 2023 results are in! Click here to learn more

← Back to Tv Foundation

TvLazyColumn

Component
in
Tv Foundation
. Since 1.0.0-alpha07

Overview

Code Examples

Video

The vertically scrolling list that only composes and lays out the currently visible items. The content block defines a DSL which allows you to emit items of different types. For example you can use TvLazyListScope.item to add a single item and TvLazyListScope.items to add a list of items.

@param modifier the modifier to apply to this layout. @param state the state object to be used to control or observe the list's state. @param contentPadding a padding around the whole content. This will add padding for the. content after it has been clipped, which is not possible via modifier param. You can use it to add a padding before the first item or after the last one. If you want to add a spacing between each item use verticalArrangement. @param reverseLayout reverse the direction of scrolling and layout. When true, items are laid out in the reverse order and TvLazyListState.firstVisibleItemIndex == 0 means that column is scrolled to the bottom. Note that reverseLayout does not change the behavior of verticalArrangement, e.g. with Arrangement.Top (top) 123### (bottom) becomes (top) 321### (bottom). @param verticalArrangement The vertical arrangement of the layout's children. This allows to add a spacing between items and specify the arrangement of the items when we have not enough of them to fill the whole minimum size. @param horizontalAlignment the horizontal alignment applied to the items. @param userScrollEnabled whether the scrolling via the user gestures or accessibility actions is allowed. You can still scroll programmatically using the state even when it is disabled. @param content a block which describes the content. Inside this block you can use methods like @param pivotOffsets offsets of child element within the parent and starting edge of the child from the pivot defined by the parentOffset. TvLazyListScope.item to add a single item or TvLazyListScope.items to add a list of items.

Overloads

TvLazyColumn

@Composable
fun TvLazyColumn(
    modifier: Modifier = Modifier,
    state: TvLazyListState = rememberTvLazyListState(),
    contentPadding: PaddingValues = PaddingValues(0.dp),
    reverseLayout: Boolean = false,
    verticalArrangement: Arrangement.Vertical =
        if (!reverseLayout) Arrangement.Top else Arrangement.Bottom,
    horizontalAlignment: Alignment.Horizontal = Alignment.Start,
    userScrollEnabled: Boolean = true,
    pivotOffsets: PivotOffsets = PivotOffsets(),
    content: TvLazyListScope.() -> Unit
)

Parameters

NameDescription
modifierthe modifier to apply to this layout.
statethe state object to be used to control or observe the list's state.
contentPaddinga padding around the whole content. This will add padding for the. content after it has been clipped, which is not possible via modifier param. You can use it to add a padding before the first item or after the last one. If you want to add a spacing between each item use verticalArrangement.
reverseLayoutreverse the direction of scrolling and layout. When true, items are laid out in the reverse order and TvLazyListState.firstVisibleItemIndex == 0 means that column is scrolled to the bottom. Note that reverseLayout does not change the behavior of verticalArrangement, e.g. with Arrangement.Top (top) 123### (bottom) becomes (top) 321### (bottom).
verticalArrangementThe vertical arrangement of the layout's children. This allows to add a spacing between items and specify the arrangement of the items when we have not enough of them to fill the whole minimum size.
horizontalAlignmentthe horizontal alignment applied to the items.
userScrollEnabledwhether the scrolling via the user gestures or accessibility actions is allowed. You can still scroll programmatically using the state even when it is disabled.
contenta block which describes the content. Inside this block you can use methods like
pivotOffsetsoffsets of child element within the parent and starting edge of the child from the pivot defined by the parentOffset. TvLazyListScope.item to add a single item or TvLazyListScope.items to add a list of items