New Compose Multiplatform components arrived on Composables UICheck it out →

← Component in Tv Foundation

TvLazyRow

Android

The horizontally 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.

Last updated:

Installation

dependencies {
   implementation("androidx.tv:tv-foundation:1.0.0-alpha10")
}

Overloads

@Composable
fun TvLazyRow(
    modifier: Modifier = Modifier,
    state: TvLazyListState = rememberTvLazyListState(),
    contentPadding: PaddingValues = PaddingValues(0.dp),
    reverseLayout: Boolean = false,
    horizontalArrangement: Arrangement.Horizontal =
        if (!reverseLayout) Arrangement.Start else Arrangement.End,
    verticalAlignment: Alignment.Vertical = Alignment.Top,
    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 [horizontalArrangement].
reverseLayoutreverse the direction of scrolling and layout. When true, items are laid out in the reverse order and [TvLazyListState.firstVisibleItemIndex] == 0 means that row is scrolled to the end. Note that [reverseLayout] does not change the behavior of [horizontalArrangement], e.g. with [Arrangement.Start] [123###] becomes [321###].
horizontalArrangementThe horizontal 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.
verticalAlignmentthe vertical 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.
pivotOffsetsoffsets of child element within the parent and starting edge of the child from the pivot defined by the parentOffset.
contenta block which describes the content. Inside this block you can use methods like [TvLazyListScope.item] to add a single item or [TvLazyListScope.items] to add a list of items.