klibs.paging — lightweight Kotlin-only library simplifies pagination in your Kotlin Multiplatform projects. Whether
you're building for Android, iOS, JVM, or JS, klibs.paging provides a clean and efficient way to handle paginated
data.
- Multiplatform Support: Works seamlessly across Android, iOS, JVM, and JS.
- Lightweight: Minimal dependencies and a small footprint.
- Easy Integration: Simple setup with Gradle.
- Flexible API: Supports both manual and automatic pagination strategies.
For a practical example, check out the sample directory in the repository. It demonstrates how to implement pagination in a Kotlin Multiplatform project.
- PagingSource<Key, Value> — defines how to load pages of data from your source (API, DB, etc).
- Pager — coordinates paging, calls your PagingSource to load pages as needed.
- PagingState — tracks loaded pages and current position.
- LoadResult — success or failure result of a page load.
- Page — a chunk of loaded data with info about previous and next keys.
- Loading infinite scroll lists from paginated REST APIs.
- Paging database query results.
- Any scenario where loading entire data set at once is inefficient or impossible.
Gradle
implementation("ru.astrainteractive.klibs:paging:<version>")
implementation(libs.klibs.paging)Version catalogs
[versions]
klibs-paging = "<latest-version>"
[libraries]
klibs-paging = { module = "ru.astrainteractive.klibs:paging", version.ref = "klibs-paging" }data class IntPageContext(val page: Int) : PageContext {
object Factory : PageContext.Factory<IntPageContext> {
override fun next(pageContext: IntPageContext): IntPageContext {
return pageContext.copy(page = pageContext.page + 1)
}
override fun prev(pageContext: IntPageContext): IntPageContext {
return pageContext.copy(page = pageContext.page - 1)
}
}
}
class IntPagerCollector<T>(
private val initialPage: Int = 0,
private val pager: PagedListDataSource<T, IntPageContext>,
) : PagingCollector<T, IntPageContext> by DefaultPagingCollector(
initialPagingStateFactory = {
PagingState(
pageContext = IntPageContext(page = initialPage),
items = emptyList(),
pageResult = PageResult.Pending
)
},
pager = pager,
pageContextFactory = IntPageContext.Factory
)private val pagingCollector = IntPagerCollector(
initialPage = 0,
pager = {
runCatching {
listOf("Hello first item!")
}
}
)
val state = pagingCollector.pagingState
fun loadItem() {
pagingCollector.loadNextPage()
}If our projects help you, consider supporting their development.
 Bitcoin |
|
 Ethereum |
|
 Boosty |
|