• Stars
    star
    639
  • Rank 70,436 (Top 2 %)
  • Language
    Java
  • License
    Apache License 2.0
  • Created over 8 years ago
  • Updated over 4 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

📃 [Android Library] Giving powers to RecyclerView

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.

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 Download 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
   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

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 ☕ to keep me recharged 🤘 [PayPal]

More Repositories

1

flutter-examples

[Examples] Simple basic isolated apps, for budding flutter devs.
Dart
6,550
star
2

android-tips-tricks

☑️ [Cheatsheet] Tips and tricks for Android Development
Java
4,680
star
3

app-privacy-policy-generator

A simple web app to generate a generic privacy policy for your Android/iOS apps
Sass
3,415
star
4

sensey

⚡ [Android Library] Play with sensor events & detect gestures in a breeze.
Java
2,676
star
5

easydeviceinfo

📱 [Android Library] Get device information in a super easy way.
Java
1,736
star
6

android-examples

:shipit: [Examples] Simple basic isolated apps, for budding android devs.
Java
1,732
star
7

qreader

🔳 [Android Library] Read QR codes using google's mobile vision api, but without the hassle
Java
368
star
8

screenshott

[Android Library] Take a screenshot of your view layout , programmatically!
Java
325
star
9

android-utils

[Android Library] Facilitating some very common functionalities in the form of utility classes for Android
Java
142
star
10

packagehunter

📥 [Android Library] Hunt down all package information
Java
140
star
11

twitterbot-nodejs

[Bot] A twitter bot made using nodejs which can post tweets, retweet other tweets and possibly fav tweets
JavaScript
139
star
12

validatetor

Android library for fast and simple string validation
Java
139
star
13

zentone

🔉 [Android Library] Easily generate audio tone of a specific frequency and volume in Android.
Kotlin
109
star
14

javadoc-themer

[Javadoc Tool] Give your boooring javadocs a splash of colors!
HTML
83
star
15

lantern

[Android Library] Handling device flash as torch for Android.
Java
82
star
16

FirebaseExample

🔥 Simplistic example app demonstrating using latest Firebase features. Checkout branches for each feature.
Java
60
star
17

UploadToBintray

[Example] Awesome library built to demonstrate the process of publishing android libraries via JCenter/Bintray
Java
53
star
18

java-interview-questions

Byte sized java tech interview coding questions
Java
43
star
19

nisrulz.github.io

Everything about Nishant Srivastava/nisrulz (online alias)
CSS
43
star
20

UploadToJitpack

[Example] Base repository to demonstrate the process of uploading an aar/jar to JitPack
Kotlin
39
star
21

OptimusHTTP

📡 [Android Library] Simplified async networking in android
Java
35
star
22

terminal-utils

[Utils] A growing list of useful terminal utility/commands and bash scripts to automate your life!
Shell
33
star
23

twitterbot-java

[Bot] Twitter bot to automate few tasks on twitter.
Java
16
star
24

ShoutOut

[Android Library] Log information in android
Kotlin
15
star
25

SelfieApp

A simple app to demonstrate building applications in android. The app lets you take selfies and show it as list inside the app.
Java
14
star
26

EvTrack

[Android Library] Make event and exception tracking like a piece of cake
Java
13
star
27

LearnKotlin

[Example] Learning Kotlin programming in Android
Kotlin
12
star
28

AndroidAutomations

An android example app to demonstrate various automations possible.
Kotlin
10
star
29

convert-md-to-pdf

Convert Markdown to PDF
JavaScript
10
star
30

puppeteer-examples

[Examples] Simple basic isolated node scripts for doing stuff with puppeteer
JavaScript
8
star
31

android-lib-init-examples

[Examples] Simple basic isolated android examples to showcase various library initialization mechanisms
Kotlin
8
star
32

SupportCamera

[Android Library] Support library to handle camera api on all android versions
Java
7
star
33

UploadToMavenCentral

[Example] Base repository to demonstrate the process of uploading an aar/jar to maven central.
Kotlin
7
star
34

nisrulz

Github Frontpage
5
star
35

ortwin-slack-bot

🛎 Your point friend in the slack workspace
JavaScript
5
star
36

Parallax-One-Pager-Template

[Template] A simple one pager parallax scrolling template
HTML
5
star
37

angular-seed

[Template] A simple angular-based seed website
CSS
4
star
38

gradle-playground

Sample project for raywenderlich.com tutorial
Kotlin
4
star
39

JetSetCompose

Example app for Jet Set Compose talk
Kotlin
4
star
40

kmp-examples

Main repository containing all the example apps demonstrating features/functionality/integrations using Kotlin MultiPlatform development.
Kotlin
4
star
41

nisrulz-android-settings

[Config] Android Studio settings and code styles used by me
3
star
42

mavenrepo

[Example] Github-Based Maven Repository
3
star
43

LearnRetrofit

[Example] Learning how to use retrofit android library
Java
3
star
44

release-automation-playstore

An automated workflow to update Playstore metadata for an android application.
Ruby
3
star
45

CoroutineRecipes

Executable example code from my talk "Cooking with Coroutines Recipes"
Kotlin
3
star
46

bygone-projects

This repository contains projects that I had worked upon in my past, possibly when I was at school (pre-college).
C++
2
star
47

advent-of-code-2021

Repository with solutions for Advent Of Code 2021 puzzles.
2
star
48

android-dev-wrapped-generator

A simple web app to generate your own Android Dev Wrapped!
HTML
2
star
49

.github

Default community health files
1
star
50

gcm-nodejs-server

[NodeJS] NodeJS GCM Server
JavaScript
1
star
51

KotlinCompileFromCmdLine

This is a repository to compile a pure kotlin project without a build system such as Gradle.
Kotlin
1
star
52

release-automation-apple-connect

An automated workflow to update Apple Appstore metadata for an iOS application.
Ruby
1
star