Skip to content

A custom Android ListView that supports endless scrolling

Notifications You must be signed in to change notification settings

ugurcany/InfiniteListView

Repository files navigation

InfiniteListView JitPack Build Status Android Arsenal Join the chat at https://gitter.im/ugurcany/InfiniteListView

InfiniteListView is a custom Android ListView that gets extended at each time new items are loaded by swiping to the bottom of list. It also supports swipe-to-refresh behavior.

See the app module for the sample usage of InfiniteListView and InfiniteListAdapter.

How it works

How it works

Classes

InfiniteListView (extends FrameLayout)

  • Includes the following UI components:

    • SwipeRefreshLayout
    • ListView
  • Set adapter as follows: infiniteListView.setAdapter(adapter);

    • adapter (InfiniteListAdapter)
      • Extend it to create your own adapter
        • Override its onNewLoadRequired() method to load new items when required (on swipe-to-bottom)
        • Override its onRefresh() method to set what to do on swipe-to-refresh
        • Override its onItemClick(position) method to set what to do on item click
        • Override its onItemLongClick(position) method to set what to do on item long-click
  • Includes the following methods:

    • infiniteListView.addNewItem(item); -> adds new item to list
    • infiniteListView.addAll(newItems); -> adds list of new items to list
    • infiniteListView.clearList(); -> clears entire list
    • infiniteListView.startLoading(); -> call this before item loading starts
    • infiniteListView.stopLoading(); -> call this after item loading ends
    • infiniteListView.hasMore(hasMore); -> call this to let the view know whether there is more to load or not
  • Custom XML attributes:

    • swipeRefreshIndicatorColor (color)
    • scrollbarVisible (boolean)
    • dividerVisible (boolean)

InfiniteListAdapter (abstract class, extends ArrayAdapter)

  • Constructor takes the following params:

    • activity (Activity)
    • itemLayoutRes (int)
      • e.g., R.layout.item_text
    • itemList (ArrayList)
  • Includes the following abstract methods:

    • onNewLoadRequired()
    • onRefresh()
    • onItemClick(position)
    • onItemLongClick(position)

How to use

Step 1. Add the JitPack repository in your root build.gradle at the end of repositories:

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

Step 2. Add the dependency:

dependencies {
    compile 'com.github.ugurcany:InfiniteListView:X.Y.Z'
}

Replace X.Y.Z with the latest release version number.

License

The MIT License (MIT)

Copyright (c) 2016 Ugurcan Yildirim

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.