How to show an empty view with a RecyclerView

Question

I am used to put an special view inside the layout file as described in the ListActivity documentation to be displayed when there is no data  This view has the id  android id empty     lt TextView     android id   android id empty      android layout width  wrap content      android layout height  wrap content      android text   string no data    gt    I wonder how this can be done with the new RecyclerView

User · Answer

I added RecyclerView and alternative ImageView to the RelativeLayout    lt RelativeLayout     android layout width  match parent      android layout height  match parent  gt        lt ImageView         android id    id no active jobs          android layout width  match parent          android layout height  match parent          android src   mipmap ic active jobs    gt        lt android support v7 widget RecyclerView xmlns android  http   schemas android com apk res android          android id    id recyclerView          android layout width  match parent          android layout height  match parent    gt    lt  RelativeLayout gt    and then in Adapter    Override public int getItemCount         if  mOrders size      0            mRecyclerView setVisibility View INVISIBLE         else           mRecyclerView setVisibility View VISIBLE             return mOrders size

User · Answer

Here is my class for show empty view  retry view  when load api failed  and loading progress for RecyclerView  public class RecyclerViewEmptyRetryGroup extends RelativeLayout       private RecyclerView mRecyclerView      private LinearLayout mEmptyView      private LinearLayout mRetryView      private ProgressBar mProgressBar      private OnRetryClick mOnRetryClick       public RecyclerViewEmptyRetryGroup Context context            this context  null              public RecyclerViewEmptyRetryGroup Context context  AttributeSet attrs            this context  attrs  0              public RecyclerViewEmptyRetryGroup Context context  AttributeSet attrs  int defStyleAttr            super context  attrs  defStyleAttr               Override     public void onViewAdded View child            super onViewAdded child           if  child getId      R id recyclerView                mRecyclerView    RecyclerView  findViewById R id recyclerView               return                    if  child getId      R id layout empty                mEmptyView    LinearLayout  findViewById R id layout empty               return                    if  child getId      R id layout retry                mRetryView    LinearLayout  findViewById R id layout retry               mRetryView setOnClickListener new OnClickListener                      Override                 public void onClick View v                        mRetryView setVisibility View GONE                       mOnRetryClick onRetry                                                  return                    if  child getId      R id progress bar                mProgressBar    ProgressBar  findViewById R id progress bar                        public void loading             mRetryView setVisibility View GONE           mEmptyView setVisibility View GONE           mProgressBar setVisibility View VISIBLE              public void empty             mEmptyView setVisibility View VISIBLE           mRetryView setVisibility View GONE           mProgressBar setVisibility View GONE              public void retry             mRetryView setVisibility View VISIBLE           mEmptyView setVisibility View GONE           mProgressBar setVisibility View GONE              public void success             mRetryView setVisibility View GONE           mEmptyView setVisibility View GONE           mProgressBar setVisibility View GONE              public RecyclerView getRecyclerView             return mRecyclerView             public void setOnRetryClick OnRetryClick onRetryClick            mOnRetryClick   onRetryClick             public interface OnRetryClick           void onRetry              activity xml   lt    RecyclerViewEmptyRetryGroup         android id    id recyclerViewEmptyRetryGroup  gt            lt android support v7 widget RecyclerView             android id    id recyclerView   gt            lt LinearLayout             android id    id layout empty  gt                           lt  LinearLayout gt            lt LinearLayout             android id    id layout retry  gt                           lt  LinearLayout gt            lt ProgressBar             android id    id progress bar   gt    lt     RecyclerViewEmptyRetryGroup gt      The source is here https   github com PhanVanLinh AndroidRecyclerViewWithLoadingEmptyAndRetry

User · Answer

RVEmptyObserver  Instead of using a custom RecyclerView  extending an AdapterDataObserver is a simpler solution that allows setting a custom View that is displayed when there are no items in the list   Example Usage   RVEmptyObserver observer   new RVEmptyObserver recyclerView  emptyView  rvAdapter registerAdapterDataObserver observer     Class   public class RVEmptyObserver extends RecyclerView AdapterDataObserver       private View emptyView      private RecyclerView recyclerView       public RVEmptyObserver RecyclerView rv  View ev            this recyclerView   rv          this emptyView      ev          checkIfEmpty               private void checkIfEmpty             if  emptyView    null  amp  amp  recyclerView getAdapter      null                boolean emptyViewVisible   recyclerView getAdapter   getItemCount      0              emptyView setVisibility emptyViewVisible   View VISIBLE   View GONE               recyclerView setVisibility emptyViewVisible   View GONE   View VISIBLE                        public void onChanged     checkIfEmpty          public void onItemRangeInserted int positionStart  int itemCount    checkIfEmpty          public void onItemRangeRemoved int positionStart  int itemCount    checkIfEmpty

User · Answer

On the same layout where is defined the RecyclerView  add the TextView    lt android support v7 widget RecyclerView     android id    id recycler view      android layout width  match parent      android layout height  match parent      android scrollbars  vertical    gt    lt TextView     android id    id empty view      android layout width  match parent      android layout height  match parent      android gravity  center      android visibility  gone      android text   string no data available    gt    At the onCreate or the appropriate callback you check if the dataset that feeds your RecyclerView is empty   If the dataset is empty  the RecyclerView is empty too  In that case  the message appears on the screen  If not  change its visibility   private RecyclerView recyclerView  private TextView emptyView           recyclerView    RecyclerView  rootView findViewById R id recycler view   emptyView    TextView  rootView findViewById R id empty view            if  dataset isEmpty          recyclerView setVisibility View GONE       emptyView setVisibility View VISIBLE     else       recyclerView setVisibility View VISIBLE       emptyView setVisibility View GONE

User · Answer

On your adapter s getItemViewType check if the adapter has 0 elements and return a different viewType if so   Then on your onCreateViewHolder check if the viewType is the one you returned earlier and inflate a diferent view  In this case a layout file with that TextView  EDIT   If this is still not working then you might want to set the size of the view programatically like this   Point size   new Point      WindowManager itemView getContext   getSystemService Context WINDOW SERVICE   getDefaultDisplay   getSize size     And then when you inflate your view call   inflatedView getLayoutParams   height   size y  inflatedView getLayoutParams   width   size x

User · Answer

Use AdapterDataObserver in custom RecyclerView  Kotlin   RecyclerViewEnum kt  enum class RecyclerViewEnum       LOADING      NORMAL      EMPTY STATE     RecyclerViewEmptyLoadingSupport kt  class RecyclerViewEmptyLoadingSupport   RecyclerView        var stateView  RecyclerViewEnum    RecyclerViewEnum LOADING         set value                field   value             setState                 var emptyStateView  View    null     var loadingStateView  View    null       constructor context  Context    super context          constructor context  Context  attrs  AttributeSet    super context  attrs          constructor context  Context  attrs  AttributeSet  defStyle  Int    super context  attrs  defStyle           private val dataObserver   object   AdapterDataObserver             override fun onChanged                 onChangeState                      override fun onItemRangeRemoved positionStart  Int  itemCount  Int                super onItemRangeRemoved positionStart  itemCount              onChangeState                      override fun onItemRangeInserted positionStart  Int  itemCount  Int                super onItemRangeInserted positionStart  itemCount              onChangeState                         override fun setAdapter adapter  RecyclerView Adapter lt   gt              super setAdapter adapter          adapter  registerAdapterDataObserver dataObserver          dataObserver onChanged               fun onChangeState             if  adapter  itemCount    0                emptyStateView  visibility   View VISIBLE             loadingStateView  visibility   View GONE             this RecyclerViewEmptyLoadingSupport visibility   View GONE           else               emptyStateView  visibility   View GONE             loadingStateView  visibility   View GONE             this RecyclerViewEmptyLoadingSupport visibility   View VISIBLE                      private fun setState              when  this stateView                RecyclerViewEnum LOADING - gt                    loadingStateView  visibility   View VISIBLE                 this RecyclerViewEmptyLoadingSupport visibility   View GONE                 emptyStateView  visibility   View GONE                            RecyclerViewEnum NORMAL - gt                    loadingStateView  visibility   View GONE                 this RecyclerViewEmptyLoadingSupport visibility   View VISIBLE                 emptyStateView  visibility   View GONE                           RecyclerViewEnum EMPTY STATE - gt                    loadingStateView  visibility   View GONE                 this RecyclerViewEmptyLoadingSupport visibility   View GONE                 emptyStateView  visibility   View VISIBLE                                   layout xml   lt  xml version  1 0  encoding  utf-8   gt   lt LinearLayout xmlns android  http   schemas android com apk res android      android layout width  match parent      android layout height  wrap content      android orientation  vertical  gt        lt LinearLayout         android id    id emptyView          android layout width  match parent          android layout height  match parent          android background   color white          android gravity  center          android orientation  vertical  gt            lt TextView             android id    id emptyLabelTv              android layout width  match parent              android layout height  wrap content              android text  empty    gt       lt  LinearLayout gt        lt LinearLayout         android id    id loadingView          android layout width  match parent          android layout height  match parent          android background   color white          android gravity  center          android orientation  vertical  gt            lt ProgressBar             android id    id progressBar              android layout width  45dp              android layout height  45dp              android layout gravity  center              android indeterminate  true              android theme   style progressBarBlue    gt       lt  LinearLayout gt        lt com peeyade components recyclerView RecyclerViewEmptyLoadingSupport         android id    id recyclerView          android layout width  match parent          android layout height  match parent    gt   lt  LinearLayout gt    in activity use this way   recyclerView  apply           layoutManager   GridLayoutManager context  2          emptyStateView   emptyView         loadingStateView   loadingView         adapter   adapterGrid               you can set LoadingView or emptyView manual     recyclerView stateView   RecyclerViewEnum EMPTY STATE     recyclerView stateView   RecyclerViewEnum LOADING

User · Answer

Just incase you are working with a FirebaseRecyclerAdapter this post works as a charm https   stackoverflow com a 39058636 6507009

User · Answer

Since Kevin s answer is not complete  This is more correct answer if you use RecyclerAdapter s notifyItemInserted and notifyItemRemoved to update dataset   See the Kotlin version another user added below     Java   mAdapter registerAdapterDataObserver new RecyclerView AdapterDataObserver           Override     public void onChanged             super onChanged            checkEmpty                Override     public void onItemRangeInserted int positionStart  int itemCount            super onItemRangeInserted positionStart  itemCount           checkEmpty                Override     public void onItemRangeRemoved int positionStart  int itemCount            super onItemRangeRemoved positionStart  itemCount           checkEmpty               void checkEmpty             mEmptyView setVisibility mAdapter getItemCount      0   View VISIBLE   View GONE               Kotlin    adapter registerAdapterDataObserver object   RecyclerView AdapterDataObserver         override fun onChanged             super onChanged           checkEmpty              override fun onItemRangeInserted positionStart  Int  itemCount  Int            super onItemRangeInserted positionStart  itemCount          checkEmpty              override fun onItemRangeRemoved positionStart  Int  itemCount  Int            super onItemRangeRemoved positionStart  itemCount          checkEmpty              fun checkEmpty             empty view visibility    if  adapter itemCount    0  View VISIBLE else View GONE

User · Answer

if you want to display a text view when the recycler view is empty you can do it like this   ArrayList lt SomeDataModel gt  arrayList   new ArrayList lt  gt      RecycleAdapter recycleAdapter    new RecycleAdapter getContext   project Ideas    recyclerView  setAdapter recycleAdapter    if arrayList isEmpty          emptyTextView setVisibility View VISIBLE       recyclerView setVisibility View GONE      I Assume you have TextView and XML like this  android visibility  quot gone quot

User · Answer

One more way is to use addOnChildAttachStateChangeListener which handles appearing disappearing child views in RecyclerView   recyclerView addOnChildAttachStateChangeListener new RecyclerView OnChildAttachStateChangeListener                  Override             public void onChildViewAttachedToWindow  NonNull View view                    forEmptyTextView setVisibility View INVISIBLE                               Override             public void onChildViewDetachedFromWindow  NonNull View view                    forEmptyTextView setVisibility View VISIBLE

User · Answer

I use ViewSwitcher   lt ViewSwitcher     xmlns android  http   schemas android com apk res android      android layout width  match parent      android layout height  match parent      android id    id switcher       gt        lt android support v7 widget RecyclerView         android id    id list          android layout width  match parent          android layout height  match parent            gt        lt TextView android id    id text empty          android layout width  match parent          android layout height  match parent          android text   string list empty          android gravity  center            gt    lt  ViewSwitcher gt    in code you will check cursor dataset and switch views   void showItems Cursor items        if  items size    gt  0             mAdapter switchCursor items            if  R id list    mListSwitcher getNextView   getId                  mListSwitcher showNext                    else if  R id text empty    mListSwitcher getNextView   getId              mListSwitcher showNext              Also you can set animations if you wish with a couple lines of code  mListSwitcher setInAnimation slide in left   mListSwitcher setOutAnimation slide out right

User · Answer

Here is a solution using only a custom adapter with a different view type for the empty situation  public class EventAdapter extends      RecyclerView Adapter lt EventAdapter ViewHolder gt         private static final int VIEW TYPE EVENT   0      private static final int VIEW TYPE DATE   1      private static final int VIEW TYPE EMPTY   2       private ArrayList items       public EventAdapter ArrayList items            this items   items              Override     public int getItemCount             if items size      0               return 1           else               return items size                          Override     public int getItemViewType int position            if  items size      0                return VIEW TYPE EMPTY           else              Object item   items get position               if  item instanceof Event                    return VIEW TYPE EVENT                else                   return VIEW TYPE DATE                                      Override     public ViewHolder onCreateViewHolder ViewGroup parent  int viewType            View v          ViewHolder vh          if  viewType    VIEW TYPE EVENT                v   LayoutInflater from parent getContext    inflate                  R layout item event  parent  false               vh   new ViewHolderEvent v             else if  viewType    VIEW TYPE DATE                v   LayoutInflater from parent getContext    inflate                  R layout item event date  parent  false               vh   new ViewHolderDate v             else               v   LayoutInflater from parent getContext    inflate                  R layout item event empty  parent  false               vh   new ViewHolder v                      return vh              Override     public void onBindViewHolder EventAdapter ViewHolder viewHolder                                    final int position            int viewType   getItemViewType position           if  viewType    VIEW TYPE EVENT                                else if  viewType    VIEW TYPE DATE                                else if  viewType    VIEW TYPE EMPTY                                           public static class ViewHolder extends ParentViewHolder           public ViewHolder View v                super v                        public static class ViewHolderDate extends ViewHolder           public ViewHolderDate View v                super v                        public static class ViewHolderEvent extends ViewHolder           public ViewHolderEvent View v                super v

User · Answer

For my projects I made this solution  RecyclerView with setEmptyView method    public class RecyclerViewEmptySupport extends RecyclerView       private View emptyView       private AdapterDataObserver emptyObserver   new AdapterDataObserver                Override         public void onChanged                 Adapter lt   gt  adapter    getAdapter                if adapter    null  amp  amp  emptyView    null                    if adapter getItemCount      0                        emptyView setVisibility View VISIBLE                       RecyclerViewEmptySupport this setVisibility View GONE                                     else                       emptyView setVisibility View GONE                       RecyclerViewEmptySupport this setVisibility View VISIBLE                                                          public RecyclerViewEmptySupport Context context            super context              public RecyclerViewEmptySupport Context context  AttributeSet attrs            super context  attrs              public RecyclerViewEmptySupport Context context  AttributeSet attrs  int defStyle            super context  attrs  defStyle               Override     public void setAdapter Adapter adapter            super setAdapter adapter            if adapter    null                adapter registerAdapterDataObserver emptyObserver                      emptyObserver onChanged               public void setEmptyView View emptyView            this emptyView   emptyView            And you should use it instead of RecyclerView class    lt com maff utils RecyclerViewEmptySupport android id    id list1      android layout height  match parent      android layout width  match parent        gt    lt TextView android id    id list empty      android layout width  wrap content      android layout height  wrap content      android text  Empty        gt    and  RecyclerViewEmptySupport list         RecyclerViewEmptySupport rootView findViewById R id list1   list setLayoutManager new LinearLayoutManager context    list setEmptyView rootView findViewById R id list empty

[android] How to show an empty view with a RecyclerView?

Examples related to android

Examples related to listview

Examples related to android-recyclerview

Examples related to no-data