InfiniteScroll


Source link: https://github.com/pwittchen/InfiniteScroll

InfiniteScroll

Infinite Scroll (Endless Scrolling) for RecyclerView in Android

JavaDoc is available at: http://pwittchen.github.io/InfiniteScroll/

Contents

Motivation

For a long time I couldn't find the right implementation of the infinite scroll AKA endless scroll for Android. A few solutions I've found weren't production ready, weren't working correctly or had too many features. I wanted to have small, easy and flexible solution to implement infinite scroll for Android, which works with RecyclerView from the newest Android API. That's why this project was created. If you want to read more, check out an article about this project on my blog.

Examples

Sample app can be found in app directory.

Below, you can see an animation presenting, how sample application works.

Moreover, you can see examplary usage of this library in SearchTwitter app.

Usage

Create necessary fields in your Activity:

public RecyclerView recyclerView; private LinearLayoutManager layoutManager;

Create new InfiniteScrollListener:

private InfiniteScrollListener createInfiniteScrollListener() {

return new InfiniteScrollListener(maxItemsPerRequest, layoutManager) {

  @Override public void onScrolledToEnd(final int firstVisibleItemPosition) {

 // load your items here

 // logic of loading items will be different depending on your specific use case

  // when new items are loaded, combine old and new items, pass them to your adapter

 // and call refreshView(...) method from InfiniteScrollListener class to refresh RecyclerView

 refreshView(recyclerView, new MyAdapter(items), firstVisibleItemPosition);

  
}

}
 
}

Initialize RecyclerView and LinearLayoutManager in your Activity:

@Override protected void onCreate(Bundle savedInstanceState) {

recyclerView = (RecyclerView) findViewById(R.id.recycler_view);

 layoutManager = new LinearLayoutManager(this);

recyclerView.setHasFixedSize(true);

recyclerView.setLayoutManager(layoutManager);

// set your custom adapter
recyclerView.setAdapter(new MyAdapter(items));

// add InfiniteScrollListener as OnScrollListener
recyclerView.addOnScrollListener(createInfiniteScrollListener());
 
}

If you want to display loading progress, you should add additional view for it, show it while loading starts and hide it when loading is finished. Check exemplary app in this repository to see concrete solution.

That's it!

Download

You can depend on the library through Maven:

<dependency>
  <groupId>com.github.pwittchen</groupId>
  <artifactId>infinitescroll</artifactId>
  <version>0.0.1</version> </dependency>

or through Gradle:

dependencies {

compile 'com.github.pwittchen:infinitescroll:0.0.1' 
}

Tests

To execute unit tests run:

./gradlew test 

Code style

Code style used in the project is called SquareAndroid from Java Code Styles repository by Square available at: https://github.com/square/java-code-styles.

Static Code Analysis

To run Static Code Analysis, type:

./gradlew check 

Reports from analysis are generated in library/build/reports/ directory.

Who is using this library?

Are you using this library in your app and want to be listed here? Send me a Pull Request or an e-mail to [email protected]

License

Copyright 2016 Piotr Wittchen  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. 

Resources

A simple & fluent Android ORM, how can it be easier? And it's compatible with RxJava2!

The Bluetooth Filter library allows for a more fine grained discovery. Developed with purpose-build Android application where they connect to one or two specific Bluetooth devices in mind. The Bluetooth Filter library allows those apps to only provide a minimum list of results to their users rather instead of the usual general list of all devices found.

Widget to calibrate sensors (Orientation). This Calibrator can be embedded in your own App.

Android library which can turn any View into a draggable dialog with swipe to dismiss feature.

Project to set up basics of a Java annotation processor.

Motivations

  • Provide a fluent and complete stack to write a custom annotation processor using Android Studio
  • Set up a robust testing strategy of the Processor implementation

An easy way to build RecyclerView.Adapter. This adapter also has multiple ItemViewType, if needed.

Topics


2D Engines   3D Engines   9-Patch   Action Bars   Activities   ADB   Advertisements   Analytics   Animations   ANR   AOP   API   APK   APT   Architecture   Audio   Autocomplete   Background Processing   Backward Compatibility   Badges   Bar Codes   Benchmarking   Bitmaps   Bluetooth   Blur Effects   Bread Crumbs   BRMS   Browser Extensions   Build Systems   Bundles   Buttons   Caching   Camera   Canvas   Cards   Carousels   Changelog   Checkboxes   Cloud Storages   Color Analysis   Color Pickers   Colors   Comet/Push   Compass Sensors   Conferences   Content Providers   Continuous Integration   Crash Reports   Credit Cards   Credits   CSV   Curl/Flip   Data Binding   Data Generators   Data Structures   Database   Database Browsers   Date &   Debugging   Decompilers   Deep Links   Dependency Injections   Design   Design Patterns   Dex   Dialogs   Distributed Computing   Distribution Platforms   Download Managers   Drawables   Emoji   Emulators   EPUB   Equalizers &   Event Buses   Exception Handling   Face Recognition   Feedback &   File System   File/Directory   Fingerprint   Floating Action   Fonts   Forms   Fragments   FRP   FSM   Functional Programming   Gamepads   Games   Geocaching   Gestures   GIF   Glow Pad   Gradle Plugins   Graphics   Grid Views   Highlighting   HTML   HTTP Mocking   Icons   IDE   IDE Plugins   Image Croppers   Image Loaders   Image Pickers   Image Processing   Image Views   Instrumentation   Intents   Job Schedulers   JSON   Keyboard   Kotlin   Layouts   Library Demos   List View   List Views   Localization   Location   Lock Patterns   Logcat   Logging   Mails   Maps   Markdown   Mathematics   Maven Plugins   MBaaS   Media   Menus   Messaging   MIME   Mobile Web   Native Image   Navigation   NDK   Networking   NFC   NoSQL   Number Pickers   OAuth   Object Mocking   OCR Engines   OpenGL   ORM   Other Pickers   Parallax List   Parcelables   Particle Systems   Password Inputs   PDF   Permissions   Physics Engines   Platforms   Plugin Frameworks   Preferences   Progress Indicators   ProGuard   Properties   Protocol Buffer   Pull To   Purchases   Push/Pull   QR Codes   Quick Return   Radio Buttons   Range Bars   Ratings   Recycler Views   Resources   REST   Ripple Effects   RSS   Screenshots   Scripting   Scroll Views   SDK   Search Inputs   Security   Sensors   Services   Showcase Views   Signatures   Sliding Panels   Snackbars   SOAP   Social Networks   Spannable   Spinners   Splash Screens   SSH   Static Analysis   Status Bars   Styling   SVG   System   Tags   Task Managers   TDD &   Template Engines   Testing   Testing Tools   Text Formatting   Text Views   Text Watchers   Text-to   Toasts   Toolkits For   Tools   Tooltips   Trainings   TV   Twitter   Updaters   USB   User Stories   Utils   Validation   Video   View Adapters   View Pagers   Views   Watch Face   Wearable Data   Wearables   Weather   Web Tools   Web Views   WebRTC   WebSockets   Wheel Widgets   Wi-Fi   Widgets   Windows   Wizards   XML   XMPP   YAML   ZIP Codes