Android Save and Restore RecyclerView State/Position

May 5, 2020

Fragment

class BatchFragment : Fragment() {
    private val viewModel: BatchViewModel by viewModels()


    override fun onActivityCreated(savedInstanceState: Bundle?) {
        super.onActivityCreated(savedInstanceState)

        initList()
    }

    override fun onDestroyView() {
        super.onDestroyView()
        viewModel.listState = list.layoutManager?.onSaveInstanceState()

        // val layoutManager = list.layoutManager as GridLayoutManager
        // val position = layoutManager.findFirstVisibleItemPosition()
    }


    override fun initList() {
        adapter = LocalAdapter(viewModel)
        adapter.registerAdapterDataObserver(object : RecyclerView.AdapterDataObserver() {
            override fun onItemRangeInserted(positionStart: Int, itemCount: Int) {
                if (viewModel.listState != null) {
                    list.layoutManager?.onRestoreInstanceState(viewModel.listState)

                    // val layoutManager = list.layoutManager as GridLayoutManager
                    // layoutManager.scrollToPositionWithOffset(position, 0)
                }
            }
        })
        list.adapter = adapter

        // load items into adapter
        // adapter.submitList(...)
    }

    private class LocalAdapter(val viewModel: BatchViewModel) : ListAdapter<ViewItem, LocalAdapter.ViewHolder>(DiffCallback()) {
        // ...
    }
}

NOTE: I am using Jetpack Navigation, so I listen to onDestroyView to save state (when navigate to another fragment).

ViewModel

class BatchViewModel(application: Application) : AndroidViewModel(application) {
    var listState: Parcelable? = null
}

❤️ Is this article helpful?

Buy me a coffee☕ or support my work to keep this space 🖖 and ad-free.
If you can't, do send some 💖 to @d_luaz or help to share this article.

👶 Apps I built

Pixtory App (Alpha) - easily organize photos on your phone into a blog.
COVID-19 - data, chart, information & news.
暖心芽 (WIP) 🌞❤️🌱 - reminder of hope, warmth, thoughts and feelings.
Travelopy - travel discovery and journal
LuaPass - offline password manager
WhatIDoNow - a public log of things I am working on now

By Desmond Lua

A dream boy who enjoys making apps, travelling and gardening. Follow me on @d_luaz.

Tags:

Related entries:

RecyclerView with Cursor Adapter

RecyclerView GridLayout Multi Selection With Toolbar

RecyclerView Selection With String Key and SelectionPredicate

RecyclerView Selection (Long Key)

Android RecylerView ListAdapter (Kotlin)

Android Setup RecylerView GridLayout Multi Select Like Google Photos App

Android Fresco Optimize Performance for RecyclerView

Android RecyclerView Photo Grid Group by Date Header