Useful library to help Android developers handle databinding, adapters and paging.
⭐ Star this repository to support this project. You will contribute to increase the visibility of this library 🙂
Developed for SDK version 21 (Android 5 Lollipop) and above.
I have created this library because any android developers are using activities, fragments adapters, and paging. So I decided to create this library to make this work more faster and easier.
⚠ WARNING ⚠ : I'm using databinding with all of the bases classes in this library, so to use it you must be familiar with it.
Step 1. Add the JitPack repository to your build file. Add it in your root /build.gradle at the end of repositories:
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}Step 2. Add the dependency in /app/build.gradle :
dependencies {
...
implementation 'com.github.KhairoHumsi:Bases:0.0.4'
}Step 1. Change your xml layout viewGroup from any viewGroup to layout like bellow:
<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:tools="http://schemas.android.com/tools">
<androidx.constraintlayout.widget.ConstraintLayout
android:layout_width="match_parent"
android:layout_height="match_parent"
tools:context=".MainActivity">
</androidx.constraintlayout.widget.ConstraintLayout>
</layout>Step 2. Change the AppCompatActivity to BaseActivity like bellow:
class MainActivity : BaseActivity<ActivityMainBinding>(R.layout.activity_main) {
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
}
}The difference between BaseActivity and BaseLocalizationActivity is that weh you want to use localization in your activity you have to use BaseLocalizationActivity.
But to use it you have to add akexorcist/Localization dependency which written by Akexorcist.
Step 1. Add the dependency in /app/build.gradle :
dependencies {
...
implementation 'com.akexorcist:localization:1.2.6'
}Step 2. Change your xml layout viewGroup from any viewGroup to layout like bellow:
<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:tools="http://schemas.android.com/tools">
<androidx.constraintlayout.widget.ConstraintLayout
android:layout_width="match_parent"
android:layout_height="match_parent"
tools:context=".MainActivity">
</androidx.constraintlayout.widget.ConstraintLayout>
</layout>Step 3. Change the AppCompatActivity to BaseLocalizationActivity like bellow:
class MainActivity : BaseLocalizationActivity<ActivityMainBinding>(R.layout.activity_main) {
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
}
}Step 1. Change your xml layout viewGroup from any viewGroup to layout like bellow:
<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:tools="http://schemas.android.com/tools">
<androidx.constraintlayout.widget.ConstraintLayout
android:layout_width="match_parent"
android:layout_height="match_parent"
tools:context=".BlankFragment">
</androidx.constraintlayout.widget.ConstraintLayout>
</layout>
Step 2. Change the Fragment to BaseFragment like bellow:
class BlankFragment : BaseFragment<FragmentBlankBinding>(R.layout.fragment_blank) {
override fun onActivityCreated(savedInstanceState: Bundle?) {
super.onActivityCreated(savedInstanceState)
}
}Step 1. Change your xml layout viewGroup from any viewGroup to layout like bellow:
<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:tools="http://schemas.android.com/tools">
<androidx.constraintlayout.widget.ConstraintLayout
android:layout_width="match_parent"
android:layout_height="match_parent"
tools:context=".dialogFragment">
</androidx.constraintlayout.widget.ConstraintLayout>
</layout>
Step 2. Change the DialogFragment to BaseDialogFragment like bellow:
class DialogFragment : BaseDialogFragment<FragmentDialogBinding>(R.layout.fragment_dialog) {
override fun onActivityCreated(savedInstanceState: Bundle?) {
super.onActivityCreated(savedInstanceState)
}
}To use it you have to add implementation "androidx.paging:paging-runtime-ktx:$paging_version".
Step 1. Add the dependency in /app/build.gradle :
dependencies {
...
//paging
implementation "androidx.paging:paging-runtime-ktx:3.0.0-alpha12"
}Step 2. Change your item xml layout viewGroup from any viewGroup to layout and pass the your data class to the xml like bellow:
<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:tools="http://schemas.android.com/tools">
<data>
<variable
name="model"
type="com.khairo.basessample.models.amount.AmountModel" />
</data>
....
<androidx.appcompat.widget.AppCompatTextView
android:layout_width="@dimen/_80sdp"
android:layout_height="@dimen/_25sdp"
android:gravity="center"
android:text='@{"" + model.amount + " USD"}'
android:textColor='@{viewModel.amount == model.amount ? @color/white : @color/black}'
android:textSize="@dimen/_10ssp"
android:textStyle="bold"
app:layout_constraintBottom_toBottomOf="parent"
app:layout_constraintEnd_toEndOf="parent"
app:layout_constraintStart_toStartOf="parent"
app:layout_constraintTop_toTopOf="parent"
tools:text="@tools:sample/full_names" />
....
</layout>Step 3. Change the RecyclerView to BaseAdapter and override the functions like bellow:
class AnimatedNormalAdapter : BaseAdapter<AmountModel, BaseViewHolder<AmountModel>, AmountItemBinding>(R.layout.amount_item) {
/** This function here to init the [binding] using bind function */
override fun initBinding(view: View) {
binding = AmountItemBinding.bind(view)
}
/** This function here to init the [ViewHolder] */
override fun initViewHolder(layout: Int, view: View): BaseViewHolder<AmountModel> = ViewHolder()
/** This class here is your [ViewHolder], but you have to extend the ViewHolders and pass the [binding] */
inner class ViewHolder : ViewHolders(binding = binding) {
/** This override function comes from the [BaseViewHolder] */
override fun bind(model: AmountModel, position: Int) {
binding.let {
it.model = model
it.executePendingBindings()
}
}
}
}Step 4. In your Activity or Fragment init you adapter like bellow:
class AdapterFragment : BaseFragment<AdapterFragmentBinding>(R.layout.adapter_fragment) {
private lateinit var viewModel: AdapterViewModel
private lateinit var animatedNormalAdapter: AnimatedNormalAdapter
override fun onActivityCreated(savedInstanceState: Bundle?) {
super.onActivityCreated(savedInstanceState)
viewModel = ViewModelProvider(this).get(AdapterViewModel::class.java)
animatedNormalAdapter = AnimatedNormalAdapter(viewModel)
binding.amount.adapter = animatedNormalAdapter
viewModel.amountLiveData.observe(requireActivity(), {
animatedNormalAdapter.apply {
/**
* This function below to tell the adapter that you want paging.
* setPagingEnabled(true)
* it's by default false.
*
* NOTE:- You cant use [setItems] function or any of the other functions
* Which deal with [items] which is a variable in [BaseAdapter].
*
* You need to use [submitData] with your [PagingData<T>] as any paging logic.
*/
setPagingEnabled(false)
/**
* This function here to tell the adapter that you want the animation.
* You can use the animation with paging.
* */
setAnimationEnabled(true)
/** This function here to tell the adapter what is the list you want to use. */
setItems(it)
notifyDataSetChanged()
}
})
}
}Please fork this repository and contribute back using pull requests.
Any contributions, large or small, major features, bug fixes, are welcomed and appreciated but will be thoroughly reviewed