Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/naverz/Antonio

Android library for the adapter view (RecyclerView, ViewPager, ViewPager2)
https://github.com/naverz/Antonio

android-library recyclerview viewpager viewpager2

Last synced: 9 days ago
JSON representation

Android library for the adapter view (RecyclerView, ViewPager, ViewPager2)

Host: GitHub
URL: https://github.com/naverz/Antonio
Owner: naverz
License: apache-2.0
Created: 2021-08-25T03:44:51.000Z (about 3 years ago)
Default Branch: master
Last Pushed: 2024-07-30T08:54:35.000Z (4 months ago)
Last Synced: 2024-08-01T19:56:13.179Z (4 months ago)
Topics: android-library, recyclerview, viewpager, viewpager2
Language: Kotlin
Homepage:
Size: 288 KB
Stars: 118
Watchers: 6
Forks: 8
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-list - naverz/Antonio - Android library for the adapter view (RecyclerView, ViewPager, ViewPager2) (Kotlin)

README

# Antonio
Android library for the adapter view (RecyclerView, ViewPager, ViewPager2)

* Free from implementation of the adapter's boilerplate code!
* Free from implementation of the view holder with data-binding (Two-way binding OK)!
* ViewPager, ViewPager2, Paging2, Paging3 supported!
* Manage the recycler view state on your view model!
* There is no things to learn, if you already know about adapter views (RecyclerView, ViewPager, ViewPager2)!

# Install
## Without data binding
```groovy
dependencies {
def antonioVersion = '1.0.9-alpha'

implementation "io.github.naverz:antonio:$antonioVersion"

//For paging2
implementation "io.github.naverz:antonio-paging2:$antonioVersion"

//For paging3
implementation "io.github.naverz:antonio-paging3:$antonioVersion"

// You can implement additional dependencies as bellow, if you want to use AntonioAnnotation.
def antonioAnnotationVersion = '0.0.8-alpha'
implementation "io.github.naverz:antonio-annotation:$antonioAnnotationVersion"
//For java (You must select only one of kapt, ksp and annotationProcessor)
annotationProcessor "io.github.naverz:antonio-compiler:$antonioAnnotationVersion"
//For kotlin kapt (You must select only one of kapt, ksp and annotationProcessor)
kapt "io.github.naverz:antonio-compiler:$antonioAnnotationVersion"
//For kotlin ksp (You must select only one of kapt, ksp and annotationProcessor)
ksp "io.github.naverz:antonio-compiler:$antonioAnnotationVersion"
}
```
## With data binding
```groovy
dependencies {
def antonioVersion = '1.0.9-alpha'

implementation "io.github.naverz:antonio-databinding:$antonioVersion"

//For paging2
implementation "io.github.naverz:antonio-databinding-paging2:$antonioVersion"

//For paging3
implementation "io.github.naverz:antonio-databinding-paging3:$antonioVersion"
}
```
# Basic Usage
- Implement `AntonioBindingModel` to bind model on your **view holder layout xml**.

```kotlin
data class ContentSmallModel(
val id: String,
@DrawableRes val iconRes: Int,
val price: Int,
val onClick: (id: String) -> Unit,
val onLongClick: (id: String) -> Boolean,
val selectedIds: LiveData>
) : AntonioBindingModel {
// Layout id to be inflated
override fun layoutId(): Int = R.layout.view_holder_content_small
// Variable id in XML to be bind on bind view holder
// (e.g., onBindViewHolder in ViewHolder, onViewCreated in Fragment).
override fun bindingVariableId(): Int = BR.model
}
```
- Create your view holder layout xml with the AntonioBindingModel you implemented.
`view_holder_content_small.xml`
```xml

```
- Declare `AntonioAdapter` (or `AntonioListAdapter`) and Set adapter with your data to RecyclerView.
```kotlin
private fun initAdapter(){
// You also can specify the type of Antonio model for the adapter, if you don't need various view types.
// e.g., AntonioAdapter()
binding.recyclerView.adapter =
AntonioAdapter().apply { currentList = viewModel.antonioModels }
// Don't forget to set the layout manager to your recycler view :)
binding.recyclerView.layoutManager = GridLayoutManager(context,4)
viewModel.onDataSetChanged.observe(this) {
binding.recyclerView.adapter?.notifyDataSetChanged()
}
}

```

## LifecycleOwner will be injected automatically!
LifecycleOwner, which is nearest from the view, will be automatically injected on All of XML inflated from `AutoBindingModel` in order to use LiveData for two-way binding.

# Awesome wiki!
- [Additional tips for Data binding](https://github.com/naverz/Antonio/wiki/Additional-tips-for-Data-binding)
- [With Data Binding](https://github.com/naverz/Antonio/wiki/Additional-tips-for-Data-binding#with-data-binding)
- [How to inject data when the view is created (e.g, onCreateViewHolder).](https://github.com/naverz/Antonio/wiki/Additional-tips-for-Data-binding#with-data-binding)
- [LifecycleOwner](https://github.com/naverz/Antonio/wiki/Additional-tips-for-Data-binding#lifecycleowner)
- [Usage without data binding](https://github.com/naverz/Antonio/wiki/Usage-without-data-binding)
- [Additional component for Antonio](https://github.com/naverz/Antonio/wiki/Additional-component-for-antonio)
- [For RecyclerView](https://github.com/naverz/Antonio/wiki/Additional-component-for-antonio#for-recyclerview)
- [For ViewPager](https://github.com/naverz/Antonio/wiki/Additional-component-for-antonio#for-viewpager)
- [For ViewPager2](https://github.com/naverz/Antonio/wiki/Additional-component-for-antonio#for-viewpager2)
- [For Adapter](https://github.com/naverz/Antonio/wiki/Additional-component-for-antonio#for-adapter)
- [Plug-in](https://github.com/naverz/Antonio/wiki/Plug-in)
- [ViewPager](https://github.com/naverz/Antonio/wiki/Plug-in#viewpager)
- [ViewPager2](https://github.com/naverz/Antonio/wiki/Plug-in#viewpager2)
- [Paging 2](https://github.com/naverz/Antonio/wiki/Plug-in#paging2)
- [Paging-3](https://github.com/naverz/Antonio/wiki/Plug-in#paging3)
- [AdapterView state (RecyclerView, ViewPager)](https://github.com/naverz/Antonio/wiki/AdapterView-state-(RecyclerView,-ViewPager))
- [How to use](https://github.com/naverz/Antonio/wiki/AdapterView-state-(RecyclerView,-ViewPager)#how-to-use)
- [Why AdapterView cannot be expressed as a state in your view model.](https://github.com/naverz/Antonio/wiki/AdapterView-state-(RecyclerView,-ViewPager)#why-adapterview-cannot-be-expressed-as-a-state-in-your-view-model)
- [Dependency injection](https://github.com/naverz/Antonio/wiki/AdapterView-state-(RecyclerView,-ViewPager)#dependency-injection)
- [For test code](https://github.com/naverz/Antonio/wiki/AdapterView-state-(RecyclerView,-ViewPager)#for-test-code)

# Sample
[The sample module](./sample) is available!

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.
```