SnappySmoothScroller

Additional

Language
Java
Version
N/A
Created
Jul 7, 2016
Updated
Feb 13, 2017 (Retired)
Owner
Shinichi Nishimura (nshmura)
Contributor
Shinichi Nishimura (nshmura)
1
Activity
Badge
Generate
Download
Source code
APK file

Show card

SnappySmoothScroller

An Android library that enables snappy smooth scrolling in RecyclerView.

Samples

Getting Started

In your build.gradle:

 repositories {
    jcenter()
 }

 dependencies {
    compile 'com.nshmura:snappysmoothscroller:1.0.0'
 }

Setup the SnappyLayoutManager:

// Instantiate layout manager
layoutManager = new SnappyLinearLayoutManager(context);

// Set the SnapType
layoutManager.setSnapType(SnapType.CENTER);

// Set the Interpolator
layoutManager.setSnapInterpolator(new DecelerateInterpolator());

// Attach layout manager to the RecyclerView:
recyclerView.setLayoutManager(layoutManager);

Call smoothScrollToPosition(int):

recyclerView.smoothScrollToPosition(position);

SnappyLayoutManager

There is same pre-set SnappyLayoutManager inherits existing layout manager:

  • SnappyLinearLayoutManager (subclass of LinearLayoutManager)
  • SnappyGridLayoutManager (subclass of GridLayoutManager)
  • SnappyStaggeredGridLayoutManager (subclass of StaggeredGridLayoutManager)

Change the behavior

You can change the behavior:

//Change the SnapType. SnapType indicates the stoping position of smooth scroll.
layoutManager.setSnapType(SnapType.CENTER);

//Change the durations for snap animation.
layoutManager.setSnapDuration(1000);

//Change the interpolator for the snaping animation.
layoutManager.setSnapInterpolator(new DecelerateInterpolator());

//Change the padding for the start parts of the view.
layoutManager.setSnapPaddingStart(10);

//Change the padding for the end parts of the view.
layoutManager.setSnapPaddingEnd(10);

//Change the padding for the start and end parts of the view.
layoutManager.setSnapPadding(10);

//Change the durations for the seeking animation.
layoutManager.setSeekDuration(1000);

Attatching SnappySmoothScroller Directly

You can also set the SnappySmoothScroller to layout manager by overriding the smoothScrollToPosition method:

layoutManager = new LinearLayoutManager(context, LinearLayoutManager.HORIZONTAL, false) {
    @Override
    public void smoothScrollToPosition(RecyclerView recyclerView, RecyclerView.State state, int position) {
        SnappySmoothScroller scroller = new SnappySmoothScroller.Builder()
                .setPosition(position)
                .setScrollVectorDetector(new LinearLayoutScrollVectorDetector(this))
                .build(recyclerView.getContext());

        startSmoothScroll(scroller);
    }
};
recyclerView.setLayoutManager(layoutManager);

Thanks

Customizing SmoothScroller for the RecyclerView

License

Copyright (C) 2016 nshmura

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.