bhavdip/android-parallax-recyclerview

An adapter which could be used to achieve a parallax effect on RecyclerView.

android-parallax-recycleview

Integration

Step 1. Add the JitPack repository to your build file

repositories {
    maven {
        url "https://jitpack.io"
    }
}

Step 2. Add the dependency

dependencies {
	compile 'com.github.kanytu:android-parallax-recyclerview:v1.2'
}

USAGE

(Example project - https://github.com/kanytu/example-parallaxrecycler)

• Create your object list and pass it to the constructor of ParallaxRecyclerAdapter

List<String> myContent = new ArrayList<String>(); // or another object list
ParallaxRecyclerAdapter myAdapter = new ParallaxRecyclerAdapter(myContent); // pass the list to the constructor

• Implement ParallaxRecyclerAdapter.RecyclerAdapterMethods.

myAdapter.implementRecyclerAdapterMethods(new ParallaxRecyclerAdapter.RecyclerAdapterMethods() {
  @Override
  public void onBindViewHolder(RecyclerView.ViewHolder viewHolder, int i) {
    // If you're using your custom handler (as you should of course) 
    // you need to cast viewHolder to it.
    ((MyCustomViewHolder) viewHolder).textView.setText(myContent.get(i)); // your bind holder routine.
  }
  
  @Override
  public RecyclerView.ViewHolder onCreateViewHolder(ViewGroup viewGroup, int i) {
    // Here is where you inflate your row and pass it to the constructor of your ViewHolder
    return new MyCustomViewHolder(LayoutInflater.from(
               viewGroup.getContext()).inflate(R.layout.myRow, viewGroup, false));
  }
  
  @Override
  public int getItemCount() {
    // return the content of your array
    return myContent.size();
  }
});

• Now we set the parallax header. You need to pass the RecyclerView too to implement the scroll listeners.

myAdapter.setParallaxHeader(LayoutInflater.from(this).inflate(
    R.layout.myParallaxView, myRecycler, false), myRecyclerView);

There a few other listeners you can implement:

// Event triggered when you click on a item of the adapter.
void onClick(View v, int position); 

// Event triggered when the parallax is being scrolled.
void onParallaxScroll(float percentage, float offset, View parallax); 

RESULT

COOL EFFECTS YOU CAN DO WITH THIS LIBRARY

• Transparent toolbar effect

@Override
public void onParallaxScroll(float percentage, float offset, View parallax) {
  Drawable c = mToolbar.getBackground();
  c.setAlpha(Math.round(percentage * 255));
  mToolbar.setBackground(c);
}

License

Copyright (c) 2014 Pedro Oliveira

Licensed under the Apache License, Version 2.0