redwood-lazylayout-compose/app.cash.redwood.lazylayout.compose

Package-level declarations

Types

ExperimentalRedwoodLazyLayoutApi

annotation class ExperimentalRedwoodLazyLayoutApi

LazyListScope

interface LazyListScope

Receiver scope which is used by LazyColumn and LazyRow.

LazyListState

open class LazyListState(val strategy: LoadingStrategy = ScrollOptimizedLoadingStrategy())

A state object that can be hoisted to control and observe scrolling.

LoadingStrategy

interface LoadingStrategy

ScrollOptimizedLoadingStrategy

class ScrollOptimizedLoadingStrategy(defaultPreloadItemCount: Int = DEFAULT_PRELOAD_ITEM_COUNT, scrollInProgressPreloadItemCount: Int = SCROLL_IN_PROGRESS_PRELOAD_ITEM_COUNT, primaryPreloadItemCount: Int = PRIMARY_PRELOAD_ITEM_COUNT, secondaryPreloadItemCount: Int = SECONDARY_PRELOAD_ITEM_COUNT) : LoadingStrategy

A loading strategy that preloads items above and below the visible range.

Functions

items

inline fun <T> LazyListScope.items(items: Array<T>, crossinline itemContent: @Composable (item: T) -> Unit)

Adds an array of items.

inline fun <T> LazyListScope.items(items: List<T>, crossinline itemContent: @Composable (item: T) -> Unit)

Adds a list of items.

itemsIndexed

inline fun <T> LazyListScope.itemsIndexed(items: Array<T>, crossinline itemContent: @Composable (index: Int, item: T) -> Unit)

Adds an array of items where the content of an item is aware of its index.

inline fun <T> LazyListScope.itemsIndexed(items: List<T>, crossinline itemContent: @Composable (index: Int, item: T) -> Unit)

Adds a list of items where the content of an item is aware of its index.

LazyColumn

@Composable

fun LazyColumn(placeholder: @Composable () -> Unit, modifier: Modifier = Modifier, state: LazyListState = rememberLazyListState(), width: Constraint = Constraint.Wrap, height: Constraint = Constraint.Wrap, margin: Margin = Margin.Zero, horizontalAlignment: CrossAxisAlignment = CrossAxisAlignment.Start, content: LazyListScope.() -> Unit)

@Composable

fun LazyColumn(refreshing: Boolean, onRefresh: () -> Unit?, placeholder: @Composable () -> Unit, modifier: Modifier = Modifier, state: LazyListState = rememberLazyListState(), width: Constraint = Constraint.Wrap, height: Constraint = Constraint.Wrap, margin: Margin = Margin.Zero, horizontalAlignment: CrossAxisAlignment = CrossAxisAlignment.Start, pullRefreshContentColor: UInt, content: LazyListScope.() -> Unit)

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 LazyListScope.item to add a single item and LazyListScope.items to add a list of items.

LazyList

@Composable

fun LazyList(isVertical: Boolean, onViewportChanged: (firstVisibleItemIndex: Int, lastVisibleItemIndex: Int) -> Unit, itemsBefore: Int, itemsAfter: Int, width: Constraint, height: Constraint, margin: Margin, crossAxisAlignment: CrossAxisAlignment, scrollItemIndex: ScrollItemIndex, modifier: Modifier = Modifier, placeholder: @Composable () -> Unit, items: @Composable () -> Unit)

LazyRow

@Composable

fun LazyRow(placeholder: @Composable () -> Unit, modifier: Modifier = Modifier, state: LazyListState = rememberLazyListState(), width: Constraint = Constraint.Wrap, height: Constraint = Constraint.Wrap, margin: Margin = Margin.Zero, verticalAlignment: CrossAxisAlignment = CrossAxisAlignment.Start, content: LazyListScope.() -> Unit)

@Composable

fun LazyRow(refreshing: Boolean, onRefresh: () -> Unit?, placeholder: @Composable () -> Unit, modifier: Modifier = Modifier, state: LazyListState = rememberLazyListState(), width: Constraint = Constraint.Wrap, height: Constraint = Constraint.Wrap, margin: Margin = Margin.Zero, verticalAlignment: CrossAxisAlignment = CrossAxisAlignment.Start, pullRefreshContentColor: UInt, content: LazyListScope.() -> Unit)

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 LazyListScope.item to add a single item and LazyListScope.items to add a list of items.

RefreshableLazyList

@Composable

fun RefreshableLazyList(isVertical: Boolean, onViewportChanged: (firstVisibleItemIndex: Int, lastVisibleItemIndex: Int) -> Unit, itemsBefore: Int, itemsAfter: Int, refreshing: Boolean, onRefresh: () -> Unit?, width: Constraint, height: Constraint, margin: Margin, crossAxisAlignment: CrossAxisAlignment, scrollItemIndex: ScrollItemIndex, pullRefreshContentColor: UInt, modifier: Modifier = Modifier, placeholder: @Composable () -> Unit, items: @Composable () -> Unit)

rememberLazyListState

@Composable

fun rememberLazyListState(strategy: LoadingStrategy = ScrollOptimizedLoadingStrategy()): LazyListState

Creates a LazyListState that is remembered across compositions.