How to save RecyclerView’s scroll position using RecyclerView.State?

by

Update

Starting from recyclerview:1.2.0-alpha02 release StateRestorationPolicy has been introduced. It could be a better approach to the given problem.

This topic has been covered on android developers medium article.

Also, @rubén-viguera shared more details in the answer below. https://stackoverflow.com/a/61609823/892500

Old answer

If you are using LinearLayoutManager, it comes with pre-built save api linearLayoutManagerInstance.onSaveInstanceState() and restore api linearLayoutManagerInstance.onRestoreInstanceState(…)

With that, you can save the returned parcelable to your outState. e.g.,

outState.putParcelable("KeyForLayoutManagerState", linearLayoutManagerInstance.onSaveInstanceState());

, and restore restore position with the state you saved. e.g,

Parcelable state = savedInstanceState.getParcelable("KeyForLayoutManagerState");
linearLayoutManagerInstance.onRestoreInstanceState(state);

To wrap all up, your final code will look something like

private static final String BUNDLE_RECYCLER_LAYOUT = "classname.recycler.layout";

/**
 * This is a method for Fragment. 
 * You can do the same in onCreate or onRestoreInstanceState
 */
@Override
public void onViewStateRestored(@Nullable Bundle savedInstanceState) {
    super.onViewStateRestored(savedInstanceState);

    if(savedInstanceState != null)
    {
        Parcelable savedRecyclerLayoutState = savedInstanceState.getParcelable(BUNDLE_RECYCLER_LAYOUT);
        recyclerView.getLayoutManager().onRestoreInstanceState(savedRecyclerLayoutState);
    }
}

@Override
public void onSaveInstanceState(Bundle outState) {
    super.onSaveInstanceState(outState);
    outState.putParcelable(BUNDLE_RECYCLER_LAYOUT, recyclerView.getLayoutManager().onSaveInstanceState());
}

Edit: You can also use the same apis with the GridLayoutManager, as it is a subclass of LinearLayoutManager. Thanks @wegsehen for the suggestion.

Edit: Remember, if you are also loading data in a background thread, you will need to a call to onRestoreInstanceState within your onPostExecute/onLoadFinished method for the position to be restored upon orientation change, e.g.

@Override
protected void onPostExecute(ArrayList<Movie> movies) {
    mLoadingIndicator.setVisibility(View.INVISIBLE);
    if (movies != null) {
        showMoviePosterDataView();
        mDataAdapter.setMovies(movies);
      mRecyclerView.getLayoutManager().onRestoreInstanceState(mSavedRecyclerLayoutState);
        } else {
            showErrorMessage();
        }
    }

More Related Contents:

  1. recyclerview No adapter attached; skipping layout
  2. How to update RecyclerView Adapter Data
  3. How to add dividers and spaces between items in RecyclerView
  4. RecyclerView inside ScrollView is not working
  5. RecyclerView expand/collapse items
  6. How to disable RecyclerView scrolling?
  7. Android Recyclerview GridLayoutManager column spacing
  8. RecyclerView header and footer
  9. Android – Implementing search filter to a RecyclerView
  10. How to add a custom button state
  11. RecyclerView and java.lang.IndexOutOfBoundsException: Inconsistency detected. Invalid view holder adapter positionViewHolder in Samsung devices
  12. RecyclerView store / restore state between activities
  13. Android GridLayout with dynamic number of columns per row
  14. Embedding ads within Recyclerview
  15. RecyclerView – How to smooth scroll to top of item on a certain position?
  16. How to save scroll position of RecyclerView in Android?
  17. How to know when the RecyclerView has finished laying down the items?
  18. How can a divider line be added in an Android RecyclerView?
  19. When switch fragment with SwipeRefreshLayout during refreshing, fragment freezes but actually still work
  20. Android : How to update the selector(StateListDrawable) programmatically
  21. Use RecyclerView inside ScrollView with flexible Recycler item height
  22. Recycle-view inflating different row :- Getting exception while binding the data
  23. Android RecyclerView: Change layout file LIST to GRID onOptionItemSelected
  24. How to add a button at the end of RecyclerView?
  25. CardView inside RecyclerView has extra margins
  26. RecyclerView﹕ No adapter attached; skipping layout
  27. Combining Two Arrays of Model Class Type Firebase Android
  28. Using Espresso to click view inside RecyclerView item
  29. Android : Control Smooth scroll over recycler view
  30. How to achieve a staggered grid layout using Jetpack compose?

Leave a Comment