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 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
RHVAdapterin your recycler view adapter andRHVViewHolderin 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
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
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:
- 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.
- If its a feature, bugfix, or anything please only change code to what you specify.
- Please keep PR titles easy to read and descriptive of changes, this will make them easier to merge :)
- Pull requests must be made against
developbranch. Any other branch (unless specified by the maintainers) will get rejected. - Check for existing issues first, before filing an issue.
- 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
1.2k Nov 19, 2022
989 Nov 17, 2022
106 Dec 23, 2022
1.7k Dec 21, 2022
423 Sep 16, 2022
193 Jun 18, 2022
151 Aug 15, 2021
77 Dec 24, 2022
1k Jan 2, 2023
425 Nov 25, 2022
270 Nov 25, 2022
4k Jan 7, 2023
3.7k Jan 8, 2023
50 Jun 13, 2022
855 Nov 11, 2022
368 Nov 25, 2022
287 Dec 22, 2022
253 Nov 11, 2022