RxPagination

Additional

Language
Kotlin
Version
1.0.0 (Mar 18, 2020)
Created
Mar 17, 2020
Updated
May 7, 2020
Owner
Mazen Rashed (mazenrashed)
Contributor
Mazen Rashed (mazenrashed)
1
Activity
Badge
Generate
Download
Source code
APK file

Promotion

RxPagination

Implement the pagination in a few lines,

Add the JitPack repository to your build file

allprojects {
    repositories {
        ...
        maven { url 'https://jitpack.io' }
    }
}

Add dependency

dependencies {
    implementation 'com.github.mazenrashed:RxPagination:${LAST_VERSION}'
}

Usage

We will use the car example,

In Your repository

Jest implement ListRepository<T>

class CarRepository : ListRepository<Car>{
...
}

Then, you need to override getDataList(page: Int, pageSize : Int) inside the repository

class CarRepository : ListRepository<Car> {  
  
    override fun getDataList(page: Int, pageSize : Int): Single<ArrayList<Car>> {  
        return endPoints.getCars(pageSize, page) //For Example (You need to return your data source here)
    }  
      
}

In The View Model

Inehet from RxPagination<T>

class CarsViewModel(carsRepository: CarRepository) :  
    RxPagination<CarRepository>(carsRepository, PAGE_SIZE, FIRST_PAGE) {  
      
    init {  
        loadDataList()  
    }
    
 }

Then, you need to override onFetchDataListSubscribed, onFetchDataListError and onFetchDataListSuccess

class CarsViewModel(carsRepository: CarRepository) :  
    RxPagination<CarRepository>(carsRepository, PAGE_SIZE, FIRST_PAGE) {  
      
    init {  
        loadDataList()  
    }
    
    override fun onFetchDataListSubscribed() {  
    //Start fetching data
    }  
  
    override fun onFetchDataListError(throwable: Throwable) {  
    
    }  
  
    override fun onFetchDataListSuccess(lastLoadedList: ArrayList<GithubRepository>) {  
   //You don't need to handle the data, but if you need it, it's available
   //This lastLoadedList is the new loaded part.
    }
 }

In the UI (Activity or Fragment)

To observe the data list, use viewModel.dataList, dataList is a BehaviorRelay<ArrayList<T>>

viewModel  
  .dataList  
  .observeOn(AndroidSchedulers.mainThread())  
  .subscribe { dataList ->  
 // notify your list adapter here 
    }

Load and reload data

viewModel.loadDataList() //To load the more data

viewModel.reloadDataList() //To reload the data

Access page informations

To access cerrent page

viewModel.page.value //Int

To check if you reach the last page

viewModel.isLastPage.value //Boolean

Contributing

We welcome contributions !

  • ⇄ Pull requests and ★ Stars are always welcome.