RecyclerViewHelper

:page_with_curl: [Android Library] Giving powers to RecyclerView

Description

RecyclerViewHelper provides the most common functions around recycler view like Swipe to dismiss, Drag and Drop, Divider in the ui, events for when item selected and when not selected, on-click listener for items.

Code Quality Rank: L5

Programming language: Java

License: Apache License 2.0

Tags: Adapter     RecyclerView     Helper     Actions    

Latest version: v27.1.1

README

Android library that provides most common functions around recycler-view like Swipe to dismiss, Drag and Drop, Divider in the ui, events for when item selected and when not selected, on-click listener for items. <!-- Bintray --> <!-- API --> <!-- Android Arsenal --> <!-- Android Dev Digest --> <!-- Android Weekly --> <!-- GitHub stars --> <!-- GitHub forks --> <!-- GitHub watchers --> <!-- Say Thanks! --> <!-- GitHub followers --> <!-- Twitter Follow -->

Also featured in Awesome Android Newsletter #Issue 21

Built with ❤︎ by Nishant Srivastava and contributors

Note: Development for pre-androidx version of this library has stopped. If you are looking for pre-androidx version, then checkout this branch. Library is compatible with AndroidX version only.

Integration

RecyclerViewHelper is available in the Jcenter, so getting it as simple as adding it as a dependency

def recyclerViewVersion="{latest version}"
// Required
implementation "androidx.recyclerview:recyclerview:${recyclerViewVersion}"

// RecyclerViewHelper
implementation "com.github.nisrulz:recyclerviewhelper:x${recyclerViewVersion}"

where {latest version} corresponds to published version in without the prepended x. This is done to distinguish between library using andoirdx vs pre-androidx.

Usage Example:

def recyclerViewVersion="1.1.0"
// Required
implementation "androidx.recyclerview:recyclerview:${recyclerViewVersion}"

// RecyclerViewHelper
implementation "com.github.nisrulz:recyclerviewhelper:x${recyclerViewVersion}"

NOTE : The version here corresponds to the version of recyclerview dependency.

Make sure that the google's maven repo is declared in your projects build.gradle file as below

  allprojects {
    repositories {
      google()
      jcenter()
    }
  }

Usage

• Implement the RHVAdapter in your recycler view adapter and RHVViewHolder in your ItemViewHolder

  
  public class MyAdapter extends RecyclerView.Adapter<MyAdapter.ItemViewHolder> implements RVHAdapter {
  
       ...
  
      @Override
      public boolean onItemMove(int fromPosition, int toPosition) {
          swap(fromPosition, toPosition);
          return false;
      }
  
      @Override
      public void onItemDismiss(int position, int direction) {
          remove(position);
      }
  
      public class ItemViewHolder extends RecyclerView.ViewHolder implements RVHViewHolder {
          ...
  
          @Override
          public void onItemSelected(int actionstate) {
              System.out.println("Item is selected");
          }
  
          @Override
          public void onItemClear() {
              System.out.println("Item is unselected");
  
          }
      }
  
      // Helper functions you might want to implement to make changes in the list as an event is fired
      private void remove(int position) {
          dataList.remove(position);
          notifyItemRemoved(position);
      }
  
      private void swap(int firstPosition, int secondPosition) {
          Collections.swap(dataList, firstPosition, secondPosition);
          notifyItemMoved(firstPosition, secondPosition);
      }
  }
  

+ Then implement your recycler view
```java

   public class MainActivity extends AppCompatActivity {


       RecyclerView myrecyclerview;
       ArrayList<String> data;
       MyAdapter adapter;

       @Override
       protected void onCreate(Bundle savedInstanceState) {
           super.onCreate(savedInstanceState);
           setContentView(R.layout.activity_main);

           myrecyclerview = (RecyclerView) findViewById(R.id.rv_fruits);

           data = new ArrayList<>();
           data.add("Apple");
           ...
           data.add("Fig");

           // Setup your adapter
           adapter = new MyAdapter(data);
           // Setup 
           myrecyclerview.hasFixedSize();
           myrecyclerview.setLayoutManager(new LinearLayoutManager(this));
           myrecyclerview.setAdapter(adapter);


           // Setup onItemTouchHandler to enable drag and drop , swipe left or right
           ItemTouchHelper.Callback callback = new RVHItemTouchHelperCallback(adapter, true, true,
                   true);
           ItemTouchHelper helper = new ItemTouchHelper(callback);
           helper.attachToRecyclerView(myrecyclerview);

           // Set the divider in the recyclerview
           myrecyclerview.addItemDecoration(new RVHItemDividerDecoration(this, LinearLayoutManager.VERTICAL));

           // Set On Click Listener
           myrecyclerview.addOnItemTouchListener(new RVHItemClickListener(this, new RVHItemClickListener.OnItemClickListener() {
               @Override
               public void onItemClick(View view, int position) {
                   String value = "Clicked Item " + data.get(position) + " at " + position;

                   Log.d("TAG", value);
                   Toast.makeText(MainActivity.this, value, Toast.LENGTH_SHORT).show();
               }
           }));

       }
   }

Demo

[Walkthrough](img/walkthrough1.gif)

Pull Requests

I welcome and encourage all pull requests. It usually will take me within 24-48 hours to respond to any issue or request. Here are some basic rules to follow to ensure timely addition of your request:

1. Match coding style (braces, spacing, etc.) This is best achieved using CMD+Option+L (Reformat code) on Mac (not sure for Windows) with Android Studio defaults. This project uses a modified version of Grandcentrix's code style, so please use the same when editing this project.
2. If its a feature, bugfix, or anything please only change code to what you specify.
3. Please keep PR titles easy to read and descriptive of changes, this will make them easier to merge :)
4. Pull requests must be made against develop branch. Any other branch (unless specified by the maintainers) will get rejected.
5. Check for existing issues first, before filing an issue.
6. Have fun!

License

Licensed under the Apache License, Version 2.0, click here for the full license.

Author & support

This project was created by Nishant Srivastava but hopefully developed and maintained by many others. See the the list of contributors here.

Special Credits to Paul Burke and his article which got me thinking

This library contains a modified version of his implementations of ItemTouchHelper.

If you appreciate my work, consider buying me a cup of :coffee: to keep me recharged :metal: [PayPal]