Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/icerockdev/moko-paging
Pagination logic in common code for mobile (android & ios) Kotlin Multiplatform development
https://github.com/icerockdev/moko-paging
android ios kotlin kotlin-multiplatform kotlin-native moko
Last synced: about 2 months ago
JSON representation
Pagination logic in common code for mobile (android & ios) Kotlin Multiplatform development
- Host: GitHub
- URL: https://github.com/icerockdev/moko-paging
- Owner: icerockdev
- License: apache-2.0
- Created: 2020-02-17T06:05:10.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-09-12T10:06:35.000Z (about 2 years ago)
- Last Synced: 2024-07-31T20:26:43.265Z (4 months ago)
- Topics: android, ios, kotlin, kotlin-multiplatform, kotlin-native, moko
- Language: Kotlin
- Homepage: https://moko.icerock.dev/
- Size: 213 KB
- Stars: 58
- Watchers: 6
- Forks: 7
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-kotlin-multiplatform - moko-paging
README
[](http://www.apache.org/licenses/LICENSE-2.0) [ ](https://repo1.maven.org/maven2/dev/icerock/moko/paging) 
# Mobile Kotlin paging
This is a Kotlin MultiPlatform library that contains pagination logic for kotlin multiplatform
## Table of Contents
- [Features](#features)
- [Requirements](#requirements)
- [Installation](#installation)
- [Usage](#usage)
- [Samples](#samples)
- [Set Up Locally](#set-up-locally)
- [Contributing](#contributing)
- [License](#license)
## Features
- **Pagination** implements pagination logic for the data from abstract `PagedListDataSource`.
- Managing a data loading process using **Pagination** asynchronous functions: `loadFirstPage`, `loadNextPage`,
`refresh` or their duplicates with `suspend` modifier.
- Observing states of **Pagination** using `LiveData` from **moko-mvvm**.
## Requirements
- Gradle version 6.8+
- Android API 16+
- iOS version 11.0+
## Installation
root build.gradle
```groovy
allprojects {
repositories {
mavenCentral()
}
}
```
project build.gradle
```groovy
dependencies {
commonMainApi("dev.icerock.moko:paging:0.7.1")
}
```
## Usage
You can use **Pagination** in `commonMain` sourceset.
**Pagination** creation:
```kotlin
val pagination: Pagination = Pagination(
parentScope = coroutineScope,
dataSource = LambdaPagedListDataSource { currentList ->
extrenalRepository.loadPage(currentList)
},
comparator = Comparator { a: Int, b: Int ->
a - b
},
nextPageListener = { result: Result> ->
if (result.isSuccess) {
println("Next page successful loaded")
} else {
println("Next page loading failed")
}
},
refreshListener = { result: Result> ->
if (result.isSuccess) {
println("Refresh successful")
} else {
println("Refresh failed")
}
},
initValue = listOf(1, 2, 3)
)
```
Managing data loading:
```kotlin
// Loading first page
pagination.loadFirstPage()
// Loading next page
pagination.loadNextPage()
// Refreshing pagnation
pagination.refresh()
// Setting new list
pagination.setData(itemsList)
```
Observing **Pagination** states:
```kotlin
// Observing the state of the pagination
pagination.state.addObserver { state: ResourceState, Throwable> ->
// ...
}
// Observing the next page loading process
pagination.nextPageLoading.addObserver { isLoading: Boolean ->
// ...
}
// Observing the refresh process
pagination.refreshLoading.addObserver { isRefreshing: Boolean ->
// ...
}
```
## Samples
Please see more examples in the [sample directory](sample).
## Set Up Locally
- The [paging directory](paging) contains the `paging` library;
- The [sample directory](sample) contains sample apps for Android and iOS; plus the mpp-library connected to the apps.
## Contributing
All development (both new features and bug fixes) is performed in the `develop` branch. This way `master` always contains the sources of the most recently released version. Please send PRs with bug fixes to the `develop` branch. Documentation fixes in the markdown files are an exception to this rule. They are updated directly in `master`.
The `develop` branch is pushed to `master` on release.
For more details on contributing please see the [contributing guide](CONTRIBUTING.md).
## License
Copyright 2020 IceRock MAG Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.