vsukharew/AnyTypeAdapter

A completely type-safe and multitype RecyclerView Adapter

AnyTypeAdapter

The RecyclerView Adapter that is able to compose different view types in one list

This adapter is:

• Type-safe and multitype
• Written once and used for each list in a project (including DiffUtil)
• Without the need to create additional interfaces or models-wrappers. Only those ones you really need

Under the hood:

• Kotlin (with using coroutines)
• Android View Binding

Dependencies:

In your module level build.gradle add:

android {
    ...
    buildFeatures {
        viewBinding true
    }
    ...
}

dependencies {
    ...
    implementation 'io.github.vsukharew:anytypeadapter:x.y.z'
    ...
}

Usage:

1. InheritAnyTypeDelegate and AnyTypeViewHolder

class TrackDelegate : AnyTypeDelegate<Track, DelegateTrackBinding, Holder>() {

    override fun createViewHolder(itemView: View): Holder = Holder(
        // generated view binding file
        DelegateTrackBinding.bind(itemView)
    )

    override fun getItemViewType(): Int = R.layout.delegate_track

    override fun getItemId(item: Track): String = item.id

    class Holder(
        binding: DelegateTrackBinding
    ) : AnyTypeViewHolder<Track, DelegateTrackBinding>(binding) {
        // views declaration

        override fun bind(item: Track) {
            // bind data
        }
    }
}

class PerformerDelegate : AnyTypeDelegate<Performer, DelegatePerformerBinding, Holder>() {

    override fun createViewHolder(itemView: View): Holder = Holder(
        // generated view binding file
        DelegatePerformerBinding.bind(itemView)
    )

    override fun getItemViewType(): Int = R.layout.delegate_performer

    override fun getItemId(item: Performer): String = item.id

    class Holder(
        binding: DelegatePerformerBinding
    ) : AnyTypeViewHolder<Performer, DelegatePerformerBinding>(binding) {
        // views declaration

        override fun bind(item: Performer) {
            // bind data
        }
    }
}

In case of not having data to be bound inherit NoDataDelegate and NoDataViewHolder

class GoPremiumDelegate(
    private val subscribeToPremiumListener: () -> Unit
) : NoDataDelegate<GoPremiumBinding>() {

    override fun createViewHolder(itemView: View): NoDataViewHolder<GoPremiumDelegate> =
        Holder(GoPremiumBinding.bind(itemView))

    override fun getItemViewType(): Int = R.layout.delegate_go_premium

    inner class Holder(binding: GoPremiumDelegate) :
        NoDataViewHolder<GoPremiumDelegate>(binding) {
        init {
            binding.retryBtn.setOnClickListener {
                retryClickListener.invoke()
            }
        }
    }
}

2. Create adapter and delegates instances

//class-scope variables
val trackDelegate = TrackDelegate()
val performerDelegate = PerformerDelegate()
val goPremiumDelegate = GoPremiumDelegate() { /* subscribe to premium implementation */ }
val adapter = AnyTypeAdapter()

3. Create AnyTypeCollection, fill it with the data and pass it to adapter

// combine builder methods depending on your data
AnyTypeCollection.Builder()
    .add(tracks, trackDelegate)
    .addIf(goPremiumDelegate) { user !is PremiumUser }
    .addIfNotEmpty(performers, performerDelegate)
    .build()
    .let { anyTypeAdapter.setCollection(it) }