https://github.com/kaustubhpatange/composition-adapter
A way of writing RecyclerView adapter through Kotlin's DSL
https://github.com/kaustubhpatange/composition-adapter
kotlin lifecycle paging3 recyclerview recyclerview-adapter
Last synced: 3 months ago
JSON representation
A way of writing RecyclerView adapter through Kotlin's DSL
- Host: GitHub
- URL: https://github.com/kaustubhpatange/composition-adapter
- Owner: KaustubhPatange
- License: mit
- Created: 2022-10-28T07:48:16.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-09-20T15:46:19.000Z (about 2 years ago)
- Last Synced: 2025-04-08T05:34:05.932Z (6 months ago)
- Topics: kotlin, lifecycle, paging3, recyclerview, recyclerview-adapter
- Language: Kotlin
- Homepage:
- Size: 14.6 MB
- Stars: 6
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# composition-adapter
A simplified way of writing RecyclerView Adapter through Kotlin DSL promoting composition over
inheritance. It internally creates a [Paging3 Adapter](#q-why-paging3-adapter).
## Features
- Create adapters/viewHolder using Kotlin DSL.
- [Lifecycle aware](#q-lifecycle-aware-viewholder) View Holders.
- Built-in support for View binding.
- Loading state adapters (show loaders during first load or during load more).
- Less boilerplate to write.
## Quick Setup
- Add dependency or directly use the `compose-adapter` module in your project.
```groovy
implementation("io.github.kaustubhpatange:compose-adapter:$LATEST")
```
- Define adapter and ViewHolder(s) for your RecyclerView.
```kotlin
val adapter = composeAdapter {
addHolder(
DataClass::class,
DataClassViewBinding::inflate
) {
onBind = { item, _ ->
with(this.binding) {
this.textView.text = ...
// ^? "this" is your ViewBinding context.
}
}
}
}
recyclerView.adapter = adapter
```
- A [sample](sample/) app is available which implements,
- **Paging Example**: A compelete network first paging example.
- **Nested RecyclerView Example**: An example which implements nested `RecyclerView` using composition adapter.
## Apps using `composition-adapter`
| | |
| ------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 
| [Pratilipi Comics](https://play.google.com/store/apps/details?id=com.pratilipi.comics) is the most popular comic reading platform in India with over 10+ million downloads.
The home page is a paging list using `composition-adapter` having over 20+ `ViewHolder`s.
_Gif is running in 8fps with 1.5x speed._ |
## FAQs
### Q. Why Paging3 adapter?
`PagingDataAdapter` is used to support closed range data as well as open ended (paginated data).
With it's async diffutil strategy through `AsyncPagingDataDiffer`, updates are computed on a
background thread which provides performance improvement over synchronous updates. This is typically
helpful for a large dataset.
You don't need `RemoteMediator` for synchronizing local DB and network updates instead you can use
plain simple `PagingSource` with your custom logic to deal with this use case or a better way would
be to rely on HTTP cache-control headers which should be automatically respected by any HTTP client.
This way you don't need to overcomplicate things by using `RemoteMediator`.
As it is generally nothing but a `RecyclerView.Adapter`, we can also use a non-paging (static) data.
### Q. Lifecycle aware ViewHolder
`ViewHolder`s in compose adapter are lifecycle aware which means you can observe `LiveData` / `Flow`
or launch a coroutine safely within `onBind`, `onCreate`. You will get appropriate state changes
like `ON_CREATE`, `ON_RESUME`, `ON_STOP` based on when `RecyclerView` tries to recycle views.
Use `lifecycleCoroutineScope` to launch coroutines. Since `onBind` is called multiple times, it is best to collect `Flow` or `LiveData` during `onAttach`.
# License
- [The MIT License](LICENSE)
```
Copyright (c) 2022 Kaustubh Patange
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```