viewcompose-paging-androidx/com.viewcompose.paging

Package-level declarations

Types

PagingContentState

sealed interface PagingContentState

Selects the primary body that an application should compose for one Paging presentation.

PagingLifecyclePolicy

enum PagingLifecyclePolicy : Enum<PagingLifecyclePolicy>

Selects the lifetime of AndroidX Paging collection owned by a ViewCompose composition.

PagingLoadStateSnapshot

data class PagingLoadStateSnapshot(val loadType: LoadType, val combined: LoadState, val source: LoadState, val mediator: LoadState?)

Captures one load type without flattening AndroidX Paging's source and mediator origins.

ViewComposePagingItems

class ViewComposePagingItems<T : Any>

Exposes one remembered, observable AndroidX Paging presentation to ViewCompose UI.

Properties

contentState

val ViewComposePagingItems<*>.contentState: PagingContentState

Returns the observable primary-content projection of this coherent Paging presentation.

Functions

collectAsViewComposePagingItems

fun <T : Any> Flow<PagingData<T>>.collectAsViewComposePagingItems(lifecyclePolicy: PagingLifecyclePolicy = PagingLifecyclePolicy.Visible, context: CoroutineContext = EmptyCoroutineContext): ViewComposePagingItems<T>

Collects this AndroidX Paging stream into a remembered ViewCompose presentation owner.

forLoadType

fun CombinedLoadStates.forLoadType(loadType: LoadType): PagingLoadStateSnapshot

Returns combined, source, and mediator states for one refresh, prepend, or append operation.

PagingLazyColumn

fun <T : Any> UiTreeBuilder.PagingLazyColumn(items: ViewComposePagingItems<T>, key: (T) -> Any, contentType: (T) -> Any? = { null }, contentRevision: (T) -> Any? = { it }, contentPadding: UiDp = UiDp.Zero, spacing: UiDp = UiDp.Zero, state: LazyListState? = null, reverseLayout: Boolean = false, userScrollEnabled: Boolean = true, prefetchPolicy: LazyLayoutPrefetchPolicy = LazyLayoutPrefetchPolicy(), reusePolicy: CollectionReusePolicy = CollectionReusePolicy(), motionPolicy: CollectionMotionPolicy = CollectionMotionPolicy(), modifier: Modifier = Modifier, itemContent: UiTreeBuilder.(T) -> Unit)

Displays a placeholder-disabled Paging presentation in ViewCompose's native lazy column.

fun <T : Any> UiTreeBuilder.PagingLazyColumn(items: ViewComposePagingItems<T>, key: (T) -> Any, placeholderContentRevision: Any, placeholderContent: UiTreeBuilder.(index: Int) -> Unit, contentType: (T) -> Any? = { null }, contentRevision: (T) -> Any? = { it }, placeholderContentType: Any? = null, contentPadding: UiDp = UiDp.Zero, spacing: UiDp = UiDp.Zero, state: LazyListState? = null, reverseLayout: Boolean = false, userScrollEnabled: Boolean = true, prefetchPolicy: LazyLayoutPrefetchPolicy = LazyLayoutPrefetchPolicy(), reusePolicy: CollectionReusePolicy = CollectionReusePolicy(), motionPolicy: CollectionMotionPolicy = CollectionMotionPolicy(), modifier: Modifier = Modifier, itemContent: UiTreeBuilder.(T) -> Unit)

Displays loaded Paging items and positional placeholders in a native lazy column.