TvLazyListScope
@TvLazyListScopeMarker
sealed interface TvLazyListScope
Receiver scope which is used by TvLazyColumn and TvLazyRow.
Summary
Public functions |
|
|---|---|
Unit |
item(key: Any?, contentType: Any?, content: @Composable TvLazyListItemScope.() -> Unit)Adds a single item. |
Unit |
items(Adds a |
Unit |
@ExperimentalTvFoundationApiAdds a sticky header item, which will remain pinned even when scrolling after it. |
Extension functions |
|
|---|---|
inline Unit |
<T : Any?> TvLazyListScope.This function is deprecated. Use `LazyListScope.items` instead. |
inline Unit |
<T : Any?> TvLazyListScope.This function is deprecated. Use `LazyListScope.items` instead. |
inline Unit |
<T : Any?> TvLazyListScope.This function is deprecated. Use `LazyListScope.itemsIndexed` instead. |
inline Unit |
<T : Any?> TvLazyListScope.This function is deprecated. Use `LazyListScope.itemsIndexed` instead. |
Public functions
item
fun item(key: Any? = null, contentType: Any? = null, content: @Composable TvLazyListItemScope.() -> Unit): Unit
Adds a single item.
| Parameters | |
|---|---|
key: Any? = null |
a stable and unique key representing the item. Using the same key for multiple items in the list is not allowed. Type of the key should be saveable via Bundle on Android. If null is passed the position in the list will represent the key. When you specify the key the scroll position will be maintained based on the key, which means if you add/remove items before the current visible item the item with the given key will be kept as the first visible one. |
contentType: Any? = null |
the type of the content of this item. The item compositions of the same type could be reused more efficiently. Note that null is a valid type and items of such type will be considered compatible. |
content: @Composable TvLazyListItemScope.() -> Unit |
the content of the item |
items
fun items(
count: Int,
key: ((index: Int) -> Any)? = null,
contentType: (index: Int) -> Any? = { null },
itemContent: @Composable TvLazyListItemScope.(index: Int) -> Unit
): Unit
Adds a count of items.
| Parameters | |
|---|---|
count: Int |
the items count |
key: ((index: Int) -> Any)? = null |
a factory of stable and unique keys representing the item. Using the same key for multiple items in the list is not allowed. Type of the key should be saveable via Bundle on Android. If null is passed the position in the list will represent the key. When you specify the key the scroll position will be maintained based on the key, which means if you add/remove items before the current visible item the item with the given key will be kept as the first visible one. |
contentType: (index: Int) -> Any? = { null } |
a factory of the content types for the item. The item compositions of the same type could be reused more efficiently. Note that null is a valid type and items of such type will be considered compatible. |
itemContent: @Composable TvLazyListItemScope.(index: Int) -> Unit |
the content displayed by a single item |
stickyHeader
@ExperimentalTvFoundationApi
fun stickyHeader(
key: Any? = null,
contentType: Any? = null,
content: @Composable TvLazyListItemScope.() -> Unit
): Unit
Adds a sticky header item, which will remain pinned even when scrolling after it. The header will remain pinned until the next header will take its place.
| Parameters | |
|---|---|
key: Any? = null |
a stable and unique key representing the item. Using the same key for multiple items in the list is not allowed. Type of the key should be saveable via Bundle on Android. If null is passed the position in the list will represent the key. When you specify the key the scroll position will be maintained based on the key, which means if you add/remove items before the current visible item the item with the given key will be kept as the first visible one. |
contentType: Any? = null |
the type of the content of this item. The item compositions of the same type could be reused more efficiently. Note that null is a valid type and items of such type will be considered compatible. |
content: @Composable TvLazyListItemScope.() -> Unit |
the content of the header |
Extension functions
items
inline fun <T : Any?> TvLazyListScope.items(
items: Array<T>,
noinline key: ((item) -> Any)? = null,
noinline contentType: (item) -> Any? = { null },
crossinline itemContent: @Composable TvLazyListItemScope.(item) -> Unit
): Unit
Adds an array of items.
| Parameters | |
|---|---|
items: Array<T> |
the data array |
noinline key: ((item) -> Any)? = null |
a factory of stable and unique keys representing the item. Using the same key for multiple items in the list is not allowed. Type of the key should be saveable via Bundle on Android. If null is passed the position in the list will represent the key. When you specify the key the scroll position will be maintained based on the key, which means if you add/remove items before the current visible item the item with the given key will be kept as the first visible one. |
noinline contentType: (item) -> Any? = { null } |
a factory of the content types for the item. The item compositions of the same type could be reused more efficiently. Note that null is a valid type and items of such type will be considered compatible. |
crossinline itemContent: @Composable TvLazyListItemScope.(item) -> Unit |
the content displayed by a single item |
items
inline fun <T : Any?> TvLazyListScope.items(
items: List<T>,
noinline key: ((item) -> Any)? = null,
noinline contentType: (item) -> Any? = { null },
crossinline itemContent: @Composable TvLazyListItemScope.(item) -> Unit
): Unit
Adds a list of items.
| Parameters | |
|---|---|
items: List<T> |
the data list |
noinline key: ((item) -> Any)? = null |
a factory of stable and unique keys representing the item. Using the same key for multiple items in the list is not allowed. Type of the key should be saveable via Bundle on Android. If null is passed the position in the list will represent the key. When you specify the key the scroll position will be maintained based on the key, which means if you add/remove items before the current visible item the item with the given key will be kept as the first visible one. |
noinline contentType: (item) -> Any? = { null } |
a factory of the content types for the item. The item compositions of the same type could be reused more efficiently. Note that null is a valid type and items of such type will be considered compatible. |
crossinline itemContent: @Composable TvLazyListItemScope.(item) -> Unit |
the content displayed by a single item |
itemsIndexed
inline fun <T : Any?> TvLazyListScope.itemsIndexed(
items: Array<T>,
noinline key: ((index: Int, item) -> Any)? = null,
crossinline contentType: (index: Int, item) -> Any? = { _, _ -> null },
crossinline itemContent: @Composable TvLazyListItemScope.(index: Int, item) -> Unit
): Unit
Adds an array of items where the content of an item is aware of its index.
| Parameters | |
|---|---|
items: Array<T> |
the data array |
noinline key: ((index: Int, item) -> Any)? = null |
a factory of stable and unique keys representing the item. Using the same key for multiple items in the list is not allowed. Type of the key should be saveable via Bundle on Android. If null is passed the position in the list will represent the key. When you specify the key the scroll position will be maintained based on the key, which means if you add/remove items before the current visible item the item with the given key will be kept as the first visible one. |
crossinline contentType: (index: Int, item) -> Any? = { _, _ -> null } |
a factory of the content types for the item. The item compositions of the same type could be reused more efficiently. Note that null is a valid type and items of such type will be considered compatible. |
crossinline itemContent: @Composable TvLazyListItemScope.(index: Int, item) -> Unit |
the content displayed by a single item |
itemsIndexed
inline fun <T : Any?> TvLazyListScope.itemsIndexed(
items: List<T>,
noinline key: ((index: Int, item) -> Any)? = null,
crossinline contentType: (index: Int, item) -> Any? = { _, _ -> null },
crossinline itemContent: @Composable TvLazyListItemScope.(index: Int, item) -> Unit
): Unit
Adds a list of items where the content of an item is aware of its index.
| Parameters | |
|---|---|
items: List<T> |
the data list |
noinline key: ((index: Int, item) -> Any)? = null |
a factory of stable and unique keys representing the item. Using the same key for multiple items in the list is not allowed. Type of the key should be saveable via Bundle on Android. If null is passed the position in the list will represent the key. When you specify the key the scroll position will be maintained based on the key, which means if you add/remove items before the current visible item the item with the given key will be kept as the first visible one. |
crossinline contentType: (index: Int, item) -> Any? = { _, _ -> null } |
a factory of the content types for the item. The item compositions of the same type could be reused more efficiently. Note that null is a valid type and items of such type will be considered compatible. |
crossinline itemContent: @Composable TvLazyListItemScope.(index: Int, item) -> Unit |
the content displayed by a single item |