Skip to content

Latest commit

 

History

History
112 lines (84 loc) · 3.36 KB

README.md

File metadata and controls

112 lines (84 loc) · 3.36 KB
Raw

Paginated RecyclerView

Android Paginated Recycler view Library.

This is simple android library to pagination data in RecyclerView list.

Preview

Gradle

Add it in your root build.gradle at the end of repositories:

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

Add the dependency:

dependencies {
    implementation 'com.github.softrunapp:Paginated-RecyclerView:1.1.0'
}

Usage

Using Paginated RecyclerView is really simple.

  1. Create adapter class extends from PaginatedAdapter and set your model and your view holder:
    public class MyAdapter extends PaginatedAdapter<User, MyAdapter.ViewHolder> {
      ...
      @Override
      public void onBindViewHolder(@NonNull ViewHolder holder, int position) {
          getItem(position); //get item with position
      }
      ...
  1. Set items to your adapter in your Activity:
    MyAdapter adapter = new MyAdapter();
    adapter.setDefaultRecyclerView(this, R.id.recyclerView); //set recyclerview with id and Activity. by default set LinearLayout for LayoutManager and setFixSize to true
    adapter.setOnPaginationListener(new PaginatedAdapter.OnPaginationListener() {
	      @Override
	      public void onCurrentPage(int page) {
		  //current page which loaded in list
	      }

	      @Override
	      public void onNextPage(int page) {
		  // call your method to get next page
	      }

	      @Override
	      public void onFinish() {
		  // end of the list and all pages loaded
	      }
	});
  1. Get first page of your data
    adapter.submitItems(yourListData);

Customization

most of them are self-explaining

    MyAdapter adapter = new MyAdapter();
    //setters
    adapter.setStartPage(1); //set first page of data. default value is 1.
    adapter.setPageSize(10); //set page data size. default value is 10.
    adapter.setRecyclerView(recyclerView); // set your RecyclerView with options
    
    //getters
    adapter.getStartPage(); // return start page
    adapter.getCurrentPage(); // return last page which loaded
    adapter.getRecyclerView(); // return recycler view

License

MIT License

Copyright (c) 2019 Meisam Beiranvand

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.