EmptyRecyclerView

EmptyRecyclerView is an android library to give RecyclerView's an empty indicator to display on screen to show there is no content in the list.

DEMO 1	DEMO 2

Installation

Gradle

Add to project level build.gradle

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

Then to app level build.gradle

dependencies {
    implementation 'com.github.joeShuff:EmptyRecyclerView:VERSION'
}

More installation instructions at Jitpack Page

Usage

Setup

<com.joeshuff.emptyrecyclerview.EmptyRecyclerView
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:id="@+id/mainRecyclerView"
        app:empty_layout="@layout/empty_indicator_layout"
/>

Then in your activity you can set the adapter and layout manager using

Java

EmptyRecyclerView recyclerView = findViewById(R.id.mainRecyclerView);
recyclerView.setAdapter();
recyclerView.setLayoutManager();

Kotlin

mainRecyclerView.setAdapter()
mainRecyclerView.setLayoutManager()

If you need to change anything else in the RecyclerView, use

mainRecyclerView.getRecyclerView()

Features

Indicator Listener

You can add an EmptyViewCreatedListener to the EmptyRecyclerView which will notify you when the empty indicator has been created and everytime it is shown on the screen. It will also pass you a reference to the Empty indicator view so you can do whatever you like with the view. Like in DEMO1 (See table above) where we put the users search term into the empty indicator.

Example (Kotlin)

val emptyViewCreatedListener = object: EmptyViewCreatedListener {
        override fun onCreated(view: View) {

        }

        override fun onShown(view: View?) {

        }
    }

emptyRecyclerView.setOnEmptyViewCreatedListener(emptyViewCreatedListener)

Example (Java)

EmptyViewCreatedListener listener = new EmptyViewCreatedListener() {
        @Override
        public void onCreated(@NotNull View view) {

        }

        @Override
        public void onShown(@Nullable View view) {

        }
    };

emptyRecyclerView.setOnEmptyViewCreatedListener(listener);

Remove Empty Indicator

You can use the following 2 methods to both show and remove the empty indicator respectively at runtime.

emptyRecyclerView.showEmptyLayout()
emptyRecyclerView.removeEmptyLayout()

Take Note

Please make sure you use emptyRecyclerView.setAdapter() and not emptyRecyclerView.getRecyclerView.setAdapter() as the EmptyRecyclerView attaches required data observers to correctly display the empty indicator.

Contributing

Please feel free to contribute to the repository and open pull requests.

License

Copyright 2019 Joseph Shufflebotham

The MIT License (MIT)

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.

joeShuff/EmptyRecyclerView