ScalingLazyListScope
@ScalingLazyScopeMarker
sealed interface ScalingLazyListScope
Receiver scope which is used by ScalingLazyColumn.
Summary
Public functions |
|
|---|---|
Unit |
item(key: Any?, content: @Composable ScalingLazyListItemScope.() -> Unit)Adds a single item. |
Unit |
items(Adds a |
Extension functions |
|
|---|---|
inline Unit |
<T : Any?> ScalingLazyListScope.This function is deprecated. Was moved to androidx.wear.compose.foundation.lazy package. |
inline Unit |
<T : Any?> ScalingLazyListScope.This function is deprecated. Was moved to androidx.wear.compose.foundation.lazy package. |
inline Unit |
<T : Any?> ScalingLazyListScope.This function is deprecated. Was moved to androidx.wear.compose.foundation.lazy package. |
inline Unit |
<T : Any?> ScalingLazyListScope.This function is deprecated. Was moved to androidx.wear.compose.foundation.lazy package. |
Public functions
fun item(key: Any? = null, content: @Composable ScalingLazyListItemScope.() -> 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. |
content: @Composable ScalingLazyListItemScope.() -> Unit |
the content of the item |
fun items(
count: Int,
key: ((index: Int) -> Any)? = null,
itemContent: @Composable ScalingLazyListItemScope.(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. |
itemContent: @Composable ScalingLazyListItemScope.(index: Int) -> Unit |
the content displayed by a single item |
Extension functions
items
inline fun <T : Any?> ScalingLazyListScope.items(
items: Array<T>,
noinline key: ((item) -> Any)? = null,
crossinline itemContent: @Composable ScalingLazyListItemScope.(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. |
crossinline itemContent: @Composable ScalingLazyListItemScope.(item) -> Unit |
the content displayed by a single item |
items
inline fun <T : Any?> ScalingLazyListScope.items(
items: List<T>,
noinline key: ((item) -> Any)? = null,
crossinline itemContent: @Composable ScalingLazyListItemScope.(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. |
crossinline itemContent: @Composable ScalingLazyListItemScope.(item) -> Unit |
the content displayed by a single item |
itemsIndexed
inline fun <T : Any?> ScalingLazyListScope.itemsIndexed(
items: Array<T>,
noinline key: ((index: Int, item) -> Any)? = null,
crossinline itemContent: @Composable ScalingLazyListItemScope.(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 itemContent: @Composable ScalingLazyListItemScope.(index: Int, item) -> Unit |
the content displayed by a single item |
itemsIndexed
inline fun <T : Any?> ScalingLazyListScope.itemsIndexed(
items: List<T>,
noinline key: ((index: Int, item) -> Any)? = null,
crossinline itemContent: @Composable ScalingLazyListItemScope.(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 itemContent: @Composable ScalingLazyListItemScope.(index: Int, item) -> Unit |
the content displayed by a single item |