On the 21th of May 2024 this repository will change ownership and move to the personal account of one of it's maintainers, Idan Atsmon.
OneAdapter is made to simplify and enhance the use of the RecyclerView's Adapter while preventing common mistakes. With multiple modules and hooks, you don't have to think about writing an adapter anymore, and just focus on what matters.
For better understanding what drove me to write this library and what use cases it solves best, please refer to my Medium post: https://medium.com/@idanatsmon/adapting-your-recyclerview-the-2019-approach-e47edf2fc4f3
Version 2.0.0 is out with a brand new Kotlin API!
Kotlin is now the first priority of this library and as such comes a full API change, every Module, Hook and State is now created using dedicated DSLs.
Check the example below or sample project for reference for Kotlin & Java use.
- Modular approach for more reusable and testable code
- Built-in support for DiffUtil (using Diffable)
- Optimized performance - internal processing done on a background thread
- 100% written in Kotlin with Kotlin friendly API using DSLs
- Modules:
- Event Hooks:
- Others:
Root build.gradle:
allprojects {
repositories {
jcenter()
maven { url "https://jitpack.io" }
}
}App build.gradle:
dependencies {
implementation "com.github.idanatz:OneAdapter:${LATEST_VERSION}"
}Note that library interfaces and API may change slightly while the library design matures.
Please see the changes in the CHANGELOG file before upgrading.
You can try out the example project that includes basic and advanced usage in Kotlin.
Item Modules are used for the creation and binding of all ViewHolders for you. In the onBind method, you will receive as a parameter the model associated with this view and a ViewBinder class that lets you find (and cache) the views defined in the associated layout file.
class MessageModule : ItemModule<MessageModel>() {
init {
config {
layoutResource = R.layout.message_model
}
onBind { model, viewBinder, metadata ->
val title = viewBinder.findViewById<TextView>(R.id.title)
title.text = model.title
}
onUnbind { model, viewBinder, metadata ->
// unbind logic like stop animation, release webview resources, etc.
}
}
}The Adapter is calculating the difference between its current data and the modified data on a background thread and posting the result to the main thread. In order for this magic to work without writing tons of DiffUtil.Callback, your models need to implement one simple interface:
class MessageModel : Diffable {
private val id: Long = 0L
private val title: String? = null
override val uniqueIdentifier: Long = id
override fun areContentTheSame(other: Any): Boolean = other is MessageModel && title == other.title
}val oneAdapter = OneAdapter(recyclerView) {
itemModule += MessageModule()
}
oneAdapter.setItems(...) Have more than one view type? not a problem, just create another ItemModule and attach it to OneAdapter in the same way.
class MessageModule : ItemModule<MessageModel> { ... }
class StoryModule : ItemModule<StoryModel> { ... }val oneAdapter = OneAdapter(recyclerView) {
itemModule += MessageModule()
itemModule += StoryModule()
...
}Paging Module is used for creating and binding a specific ViewHolder at the end of the list when the Adapter reaches a load more state. The visible threshold configuration is used to indicate how many items before the end of the list the onLoadMore callback should be invoked.
class PagingModuleImpl : PagingModule() {
init {
config {
layoutResource = R.layout.load_more // can be some spinner animation
visibleThreshold = 3 // invoke onLoadMore 3 items before the end
}
onLoadMore { currentPage ->
// place your load more logic here, like asking the ViewModel to load the next page of data.
}
}
}val oneAdapter = OneAdapter(recyclerView) {
// itemModule += ...
pagingModule = PagingModuleImpl()
}Emptiness Module is used for creating and binding a specific ViewHolder when the Adapter has no data to render.
class EmptinessModuleImpl : EmptinessModule() {
init {
config {
layoutResource = R.layout.empty_state
}
onBind { viewBinder, metadata -> ... }
onUnbind { viewBinder, metadata -> ... }
}
}val oneAdapter = OneAdapter(recyclerView) {
// itemModule += ...
emptinessModule = EmptinessModuleImpl()
}Selection Module is used for enabling single or multiple selection on Items.
class ItemSelectionModuleImpl : ItemSelectionModule() {
init {
config {
selectionType = SelectionType.Multiple // Or SelectionType.Single
}
onStartSelection {
// place your general selection logic here, like changing the toolbar text to indicate the selected count.
}
onUpdateSelection { selectedCount -> ... }
onEndSelection { ... }
}
}class MessageModule : ItemModule<MessageModel>() {
init {
// config, onBind, etc...
states += SelectionState<MessageModel>().apply {
config {
enabled = true // decide if the selection should be enabled for this model, true by default
selectionTrigger = SelectionTrigger.LongClick // decide what trigger the selection, long or regular click
}
onSelected { model, selected ->
// insert your selected logic here.
// right after this call you will receive an onBind call in order to reflect your changes on the relevant Item Module.
}
}
}
}val oneAdapter = OneAdapter(recyclerView) {
itemModule += MessageModule()
itemSelectionModule = ItemSelectionModuleImpl()
}Item Modules can easily be enhanced with event hooks to get access to common events like clicking or swiping on an item.
Click Hook can be attached in order to recieve click events on an item.
class MessageModule : ItemModule<MessageModel>() {
init {
// config, onBind, etc...
eventHooks += ClickEventHook<MessageModel>().apply {
onClick { model, viewBinder, metadata ->
// place your on click logic here.
}
}
}
}val oneAdapter = OneAdapter(recyclerView) {
itemModule += MessageModule()
}Swipe Hook can be attached in order to receive swiping (during and when completed) events on an item.
class MessageModule : ItemModule<MessageModel>() {
init {
// config, onBind, etc...
eventHooks += SwipeEventHook<MessageModel>().apply {
config {
swipeDirection = listOf(SwipeEventHook.SwipeDirection.Start, SwipeEventHook.SwipeDirection.End)
}
onSwipe { canvas, xAxisOffset, viewBinder ->
// draw your swipe UI here.
// like painting the canvas red with a delete icon.
}
onSwipeComplete { model, viewBinder, metadata ->
// place your swipe logic here.
// like removing an item after it was swiped right.
}
}
}
}val oneAdapter = OneAdapter(recyclerView) {
itemModule += MessageModule()
}The provided Animator will be animated on the first bind of the corresponding ItemModule's models.
class MessageModule : ItemModule<MessageModel>() {
init {
config {
layoutResource = R.layout.message_model
// can be implemented by inflating Animator Xml
firstBindAnimation = AnimatorInflater.loadAnimator(this@FirstBindAnimationActivity, R.animator.item_animation_example)
// or can be implemented by constructing ObjectAnimator
firstBindAnimation = ObjectAnimator().apply {
propertyName = "translationX"
setFloatValues(-1080f, 0f)
duration = 750
}
}
onBind { model, viewBinder, metadata -> ... }
}
}Built in support for Android View Binding (https://developer.android.com/topic/libraries/view-binding) Full example is provided in the example project.
class MessageModule : ItemModule<MessageModel>() {
init {
config {
layoutResource = R.layout.message_model
}
onBind { model, viewBinder, _ ->
viewBinder.bindings(MessageModelBinding::bind).run {
title.text = model.title
body.text = model.body
Glide.with(viewBinder.rootView).load(model.avatarImageId).into(avatarImage)
}
}
}
}Built in support for Android Data Binding (https://developer.android.com/topic/libraries/data-binding) Full example is provided in the example project.
class MessageModule : ItemModule<ObservableMessageModel>() {
init {
config {
layoutResource = R.layout.message_model
}
onBind { model, viewBinder, metadata ->
viewBinder.dataBinding?.run {
setVariable(BR.messageModel, model)
lifecycleOwner = this@DataBindingActivity
executePendingBindings()
}
}
}
}Copyright (c) 2019 Idan Atsmon
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.