firestoreadapter's Introduction

FirestoreAdapter

RecyclerView Adapter for Firebase Firestore

Usage

Start by subclassing FirestoreAdapter:

class ItemAdapter(creator: QueryCreator) : FirestoreAdapter<State, ItemViewHolder>(State::class.java, creator) {

    override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): ItemViewHolder {
        return ItemViewHolder.inflate(parent)
    }

    override fun onBindViewHolder(holder: ItemViewHolder, position: Int) {
        holder.bind(get(position))
    }
}

Usage will look like so:

val firestore = FirebaseFirestore.getInstance()
val ref = firestore.collection("states")
adapter = ItemAdapter({
    ref.limit(10)
            .orderBy("name")
})

val list = findViewById<RecyclerView>(R.id.list)
val layoutManager = LinearLayoutManager(this)
list.adapter = adapter
list.layoutManager = layoutManager
//this allows for endless scrolling
adapter.setupOnScrollListener(list, layoutManager)

Limitations

Items added to a collection after queries have been started will always be added to the bottom of the list. This is due to the fact that we cannot know which query the document change originates from.
If an items position changes in the list, it will not update, only the data will. We cannot associate the changed item with the right spot in the list since it differs from the spot in the query

License

Copyright 2018 Commit 451

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.

Recommend Projects