Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
RecyclerView doesn't have an emptyView support, we gotta fix that
/*
* Copyright (C) 2015 Glowworm Software
* Copyright (C) 2014 Nizamutdinov Adel
*
* 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.
*/
// based on https://gist.github.com/adelnizamutdinov/31c8f054d1af4588dc5c
package mobi.glowworm.lib.ui.widget;
import android.content.Context;
import android.support.annotation.NonNull;
import android.support.annotation.Nullable;
import android.support.v7.widget.RecyclerView;
import android.util.AttributeSet;
import android.view.View;
public class EmptyRecyclerView extends RecyclerView {
@Nullable
private View emptyView;
public EmptyRecyclerView(Context context) {
super(context);
}
public EmptyRecyclerView(Context context, AttributeSet attrs) {
super(context, attrs);
}
public EmptyRecyclerView(Context context, AttributeSet attrs, int defStyle) {
super(context, attrs, defStyle);
}
@Override
public void setAdapter(@Nullable Adapter adapter) {
final Adapter oldAdapter = getAdapter();
if (oldAdapter != null) {
oldAdapter.unregisterAdapterDataObserver(observer);
}
if (adapter != null) {
adapter.registerAdapterDataObserver(observer);
}
super.setAdapter(adapter);
checkIfEmpty();
}
@Override
public void swapAdapter(Adapter adapter, boolean removeAndRecycleExistingViews) {
final Adapter oldAdapter = getAdapter();
if (oldAdapter != null) {
oldAdapter.unregisterAdapterDataObserver(observer);
}
if (adapter != null) {
adapter.registerAdapterDataObserver(observer);
}
super.swapAdapter(adapter, removeAndRecycleExistingViews);
checkIfEmpty();
}
@NonNull
private final AdapterDataObserver observer = new AdapterDataObserver() {
@Override
public void onChanged() {
super.onChanged();
checkIfEmpty();
}
@Override
public void onItemRangeInserted(int positionStart, int itemCount) {
super.onItemRangeInserted(positionStart, itemCount);
checkIfEmpty();
}
@Override
public void onItemRangeRemoved(int positionStart, int itemCount) {
super.onItemRangeRemoved(positionStart, itemCount);
checkIfEmpty();
}
};
/**
* Indicates the view to be shown when the adapter for this object is empty
*
* @param emptyView
*/
public void setEmptyView(@Nullable View emptyView) {
if (this.emptyView != null) {
this.emptyView.setVisibility(GONE);
}
this.emptyView = emptyView;
checkIfEmpty();
}
/**
* Check adapter item count and toggle visibility of empty view if the adapter is empty
*/
private void checkIfEmpty() {
if (emptyView == null || getAdapter() == null) {
return;
}
if (getAdapter().getItemCount() > 0) {
emptyView.setVisibility(GONE);
} else {
emptyView.setVisibility(VISIBLE);
}
}
}
@mobiRic

This comment has been minimized.

Copy link
Owner Author

mobiRic commented Sep 3, 2015

@Spotik

This comment has been minimized.

Copy link

Spotik commented Dec 23, 2015

Hi,

I've try to use this but i cant. When list is empty, nothing show!

Look at my code
http://pastebin.com/rZnr4F2A

@rusmichal

This comment has been minimized.

Copy link

rusmichal commented Jun 13, 2016

I have the same :(

@f839903061

This comment has been minimized.

Copy link

f839903061 commented Nov 17, 2017

I have the same problem
demo is here → https://pastebin.com/018ZBxXR

@mobiRic

This comment has been minimized.

Copy link
Owner Author

mobiRic commented Jun 29, 2018

EmptyRecyclerView does not come with a built in "empty view".

To use it you need to create a view that you want to display when the list is empty, and assign it by calling EmptyRecyclerView.setEmptyView(View).

I normally create a view in the same layout file that the EmptyRecyclerView is in.

@mobiRic

This comment has been minimized.

Copy link
Owner Author

mobiRic commented Jun 29, 2018

If anyone has trouble with it not displaying the "empty view", I would love to know more details about the issue. It could be that runtime view creation has something to do with the problem. Try adding the view to the same xml layout file as this EmptyRecyclerView.

I've used this in production apps for a few years now with no issues - but if problems are experienced I would like to fix them.

@Spotik @rusmichal @f839903061 in case you were ever able to figure out what the problem was, or have any time to help?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.