lazy-paging-kmp

0.0.2indexed

Wrapping LazyPagingItems into lazy columns that auto-handle loading, empty, error and pull-to-refresh states; exposes resolved paging state so UI code focuses only on state rendering.

AndroidNative·felipearpa/lazy-paging-kmp

Stars

—

Used by

dependents

—

Health

/ 100

lazy-paging-kmp

A Kotlin Multiplatform library that wraps AndroidX Paging's LazyPagingItems in Compose Multiplatform lazy columns with built-in loading, empty, error, and pull-to-refresh states.

Overview

lazy-paging provides two composables that consume a LazyPagingItems<T> and render the right UI for its current paging state:

LazyPagingColumn — a LazyColumn that swaps between loading / empty / error / content slots.
RefreshableLazyPagingColumn — the same, wrapped in a Material 3 PullToRefreshBox.

State resolution is exposed via the sealed LazyPagingColumnState and computed by rememberLazyPagingColumnState, so you only write UI for the state, not the paging-flag arithmetic.

Platforms

Android (JVM 17, minSdk 28, compileSdk 35)
iOS Arm64
iOS Simulator Arm64

Installation

Add Maven Central in settings.gradle.kts if it isn't there:

dependencyResolutionManagement {
    repositories {
        mavenCentral()
    }
}

Then add the dependency (Compose Multiplatform module, typically in commonMain):

kotlin {
    sourceSets {
        commonMain.dependencies {
            implementation("com.felipearpa:lazy-paging:0.0.2")
        }
    }
}

Quick Example

@Composable
fun ItemsScreen(pager: Pager<Int, Item>) {
    val lazyPagingItems = pager.flow.collectAsLazyPagingItems()

    RefreshableLazyPagingColumn(
        modifier = Modifier.fillMaxSize(),
        lazyPagingItems = lazyPagingItems,
        contentPadding = PaddingValues(16.dp),
        loadingContent = { item { CircularProgressIndicator() } },
        errorContent = { exception ->
            item {
                Column {
                    Text(exception.message ?: )
                    Button(onClick = { lazyPagingItems.retry() }) { Text() }
                }
            }
        },
        emptyContent = { item { Text() } },
    ) {
        items(
            count = lazyPagingItems.itemCount,
            key = lazyPagingItems.itemKey { it.id },
        ) { index ->
            lazyPagingItems[index]?.let { ItemRow(it) }
        }
    }
}

Sample

A runnable sample lives in sample/ (shared KMP code) and sample-android/ (Android launcher). It exercises bidirectional paging, append/prepend errors, empty results, slow network, and initial-load failures.