Android Save and Restore FirestoreUI FirestoreRecyclerAdapter State/Position

May 5, 2020

Fragment

class HomeFragment : Fragment() {
    private val viewModel: HomeViewModel by viewModels()

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

        initList()
    }

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

    private fun initList() {
        val query = ...
        val options: FirestoreRecyclerOptions<Post> = FirestoreRecyclerOptions.Builder<Post>()
            .setQuery(query, SnapshotParser { doc ->
                // replace with your own implementation
                Post.toObject(doc)
            })
            .setLifecycleOwner(this)
            .build()

        adapter = LocalAdapter(options, viewModel)

        // this doesn't work as onItemRangeInserted is called multiple times (one by one)
        /*
        adapter.registerAdapterDataObserver(object : RecyclerView.AdapterDataObserver() {
            override fun onItemRangeInserted(positionStart: Int, itemCount: Int) {
                if (viewModel.listState != null) {
                    list.layoutManager?.onRestoreInstanceState(viewModel.listState)
                    viewModel.listState = null
                }
            }
        })
         */

        // use this instead
        adapter.snapshots.addChangeEventListener(object : ChangeEventListener {
            override fun onDataChanged() {
                Timber.d(" Data Changed")
                if (viewModel.listState != null) {
                    list.layoutManager?.onRestoreInstanceState(viewModel.listState)
                    viewModel.listState = null
                }
            }

            override fun onChildChanged(
                type: ChangeEventType,
                snapshot: DocumentSnapshot,
                newIndex: Int,
                oldIndex: Int
            ) {

            }

            override fun onError(e: FirebaseFirestoreException) {

            }
        })

        list.adapter = adapter
    }
}

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

ViewModel

class HomeViewModel : ViewModel() {
    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

Travelopy - discover travel places in Malaysia, Singapore, Taiwan, Japan.
Pixtory App (Alpha) - easily organize photos on your phone into a blog.
暖心芽 (WIP) 🌞❤️🌱 - reminder of hope, warmth, thoughts and feelings (or just quotes).
LuaPass - offline password manager

By Desmond Lua

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

Tags:

Jetpack Compose load Firestore Data with Flow

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