https://github.com/hoc081098/viewbindingdelegate
Simple one-liner ViewBinding in Fragments and Activities with Kotlin 🍄 Simplify usage of Android View Binding with Kotlin Property Delegates and solve behavior of Fragment’s ViewLifecycleOwner 🌱 ViewBindingPropertyDelegate
https://github.com/hoc081098/viewbindingdelegate
android-view-binding-delegate android-viewbinding-delegate android-viewbing androidviewbinding view-binding view-binding-delegate viewbinding viewbinding-delegate viewbinding-property-delegate viewbindingdelegate viewbindingpropertydelegate
Last synced: 6 months ago
JSON representation
Simple one-liner ViewBinding in Fragments and Activities with Kotlin 🍄 Simplify usage of Android View Binding with Kotlin Property Delegates and solve behavior of Fragment’s ViewLifecycleOwner 🌱 ViewBindingPropertyDelegate
- Host: GitHub
- URL: https://github.com/hoc081098/viewbindingdelegate
- Owner: hoc081098
- License: mit
- Created: 2020-08-06T10:28:59.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2025-03-12T17:25:22.000Z (7 months ago)
- Last Synced: 2025-03-29T14:11:24.408Z (7 months ago)
- Topics: android-view-binding-delegate, android-viewbinding-delegate, android-viewbing, androidviewbinding, view-binding, view-binding-delegate, viewbinding, viewbinding-delegate, viewbinding-property-delegate, viewbindingdelegate, viewbindingpropertydelegate
- Language: Kotlin
- Homepage: https://jitpack.io/#hoc081098/ViewBindingDelegate
- Size: 4.79 MB
- Stars: 115
- Watchers: 2
- Forks: 16
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# ViewBindingDelegate
## Author: [Petrus Nguyễn Thái Học](https://github.com/hoc081098)
- Simplify usage of Android View Binding with Kotlin Property Delegates and solve behavior of Fragment’s ViewLifecycleOwner.
- Simple one-liner ViewBinding in Fragments and Activities with Kotlin.
- Lightweight and simple library.
[](https://jitpack.io/#hoc081098/ViewBindingDelegate)
[](https://opensource.org/licenses/MIT)
[](https://ktlint.github.io/)
[](http://kotlinlang.org)
[](https://android-arsenal.com/api?level=14)
[](https://hits.seeyoufarm.com)
Liked some of my work? Buy me a coffee (or more likely a beer)
[](https://www.buymeacoffee.com/hoc081098)
## Medium article
Read [ViewBinding Delegate — one line](https://hoc081098.medium.com/viewbinding-delegate-one-line-4d0cdcbf53ba) to get details about implementation.
## Getting Started
### 1. Add the JitPack repository to your build file
Add it in your root build.gradle at the end of repositories:
- Kotlin
```kotlin
allprojects {
repositories {
...
maven(url = "https://jitpack.io")
}
}
```
- Groovy
```gradle
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}
```
### 2. Add the dependency
```kotlin
dependencies {
implementation("com.github.hoc081098:ViewBindingDelegate:1.4.0")
}
```
### 3. Enable ViewBinding
https://developer.android.com/topic/libraries/view-binding#setup
## Usage
```kotlin
import com.hoc081098.viewbindingdelegate.*
```
### 1. Activity (with reflection). [See example](https://github.com/hoc081098/ViewBindingDelegate/blob/master/app/src/main/java/com/hoc081098/example/MainActivity.kt)
Click to expand
```kotlin
class MainActivity : AppCompatActivity(R.layout.activity_main) {
private val viewBinding by viewBinding()
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
viewBinding.button.setOnClickListener {
startActivity(Intent(this@MainActivity, SecondActivity::class.java))
}
}
}
```
### 2. Activity (without reflection): Pass `::bind` method reference. [See example](https://github.com/hoc081098/ViewBindingDelegate/blob/master/app/src/main/java/com/hoc081098/example/SecondActivity.kt)
Click to expand
```kotlin
class SecondActivity : AppCompatActivity(R.layout.activity_second) {
private val binding by viewBinding(ActivitySecondBinding::bind)
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
binding.root
}
}
```
### 3. Fragment (with reflection). [See example](https://github.com/hoc081098/ViewBindingDelegate/blob/master/app/src/main/java/com/hoc081098/example/ReflectionFragment.kt)
Click to expand
```kotlin
class FirstFragment : Fragment(R.layout.fragment_first) {
private val binding by viewBinding {
button.setOnClickListener(null)
}
override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
super.onViewCreated(view, savedInstanceState)
binding.button.setOnClickListener {
findNavController().navigate(R.id.actionFirstFragmentToSecondFragment)
}
}
}
```
### 4. Fragment (without reflection): Pass `::bind` method reference. [See example](https://github.com/hoc081098/ViewBindingDelegate/blob/master/app/src/main/java/com/hoc081098/example/NotReflectionFragment.kt)
Click to expand
```kotlin
class SecondFragment : Fragment(R.layout.fragment_second) {
private val binding by viewBinding(FragmentSecondBinding::bind)
override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
super.onViewCreated(view, savedInstanceState)
binding.root
}
}
```
### 5. Includes `` tag layout: Create 2 `ViewBinding` property. [See example](https://github.com/hoc081098/ViewBindingDelegate/blob/master/app/src/main/java/com/hoc081098/example/Reflection2Fragment.kt)
Click to expand
```kotlin
class ThirdFragment : Fragment(R.layout.fragment_third) {
private val includeBinding by viewBinding()
private val binding by viewBinding { buttonThird.setOnClickListener(null) }
override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
super.onViewCreated(view, savedInstanceState)
includeBinding.textViewThirdInclude.text = "Working..."
binding.buttonThird.setOnClickListener {
Toast.makeText(requireContext(), "Clicked", Toast.LENGTH_SHORT).show()
}
}
}
```
### 6. The `Dialog` of `DialogFragment`[See example](https://github.com/hoc081098/ViewBindingDelegate/blob/master/app/src/main/java/com/hoc081098/example/DemoDialogFragment.kt)
Extends `DefaultViewBindingDialogFragment` or implements `ViewBindingDialogFragment`.
Click to expand
```kotlin
class DemoDialogFragment : DefaultViewBindingDialogFragment() {
private val viewBinding by dialogFragmentViewBinding(R.id.root, DialogFragmentDemoBinding::bind)
private val viewBinding2 by dialogFragmentViewBinding(R.id.root)
override fun onCreateDialog(savedInstanceState: Bundle?): Dialog {
return AlertDialog.Builder(requireContext())
.setTitle("Demo dialog")
.setNegativeButton("Cancel") { _, _ -> }
.setPositiveButton("OK") { _, _ -> }
.setView(R.layout.dialog_fragment_demo)
.create()
}
override fun onResume() {
super.onResume()
viewBinding.textInputLayout
viewBinding2.textInputLayout
}
}
```
### 7. `inflateViewBinding` extension methods on `ViewGroup`/`LayoutInflater`/`Context`. [See example](https://github.com/hoc081098/ViewBindingDelegate/blob/master/app/src/main/java/com/hoc081098/example/DemoAdapter.kt)
Can be used in `RecyclerView.Adapter # onCreateViewHolder` to easily create a `RecyclerView.ViewHolder` with a `ViewBinding`.
Click to expand
```kotlin
import com.hoc081098.viewbindingdelegate.inflateViewBinding
class DemoAdapter : ListAdapter(...) {
override fun onCreateViewHolder(parent: ViewGroup, viewType: Int) = VH(parent inflateViewBinding false)
override fun onBindViewHolder(holder: VH, position: Int) = holder.bind(getItem(position))
class VH(private val binding: ItemRecyclerBinding) : RecyclerView.ViewHolder(binding.root) {
fun bind(item: String) { ... }
}
}
```
## Note
### 1. Activity
Must `setContentView` before access `ViewBinding` property. This can be done easily with `constructor`:
```java
public AppCompatActivity(@LayoutRes int contentLayoutId) { ... }
```
```kotlin
class MainActivity : AppCompatActivity(R.layout.activity_main) { ... }
```
### 2. Fragment
`Fragment`'s `View` must be not null before access `ViewBinding` property. This can be done easily with `constructor`:
```java
public Fragment(@LayoutRes int contentLayoutId) { ... }
```
```kotlin
class FirstFragment : Fragment(R.layout.fragment_first) { ... }
```
### 3. Proguard
If there is any problem with `Proguard`, add below to your `app/proguard-rules.pro`:
```
# ViewBindingDelegate uses Reflection.
-keepclassmembers class ** implements androidx.viewbinding.ViewBinding {
public static ** bind(android.view.View);
public static ** inflate(android.view.LayoutInflater, android.view.ViewGroup, boolean);
public static ** inflate(android.view.LayoutInflater, android.view.ViewGroup);
}
```
### 4. Throws `IllegalStateException`: "Attempt to get view binding when fragment view is destroyed" when accessing delegate property in `onDestroyView`
Since version `1.0.0-alpha03 - Feb 16, 2021`, we cannot access ViewBinding delegate property in `onDestroyView` (this causes many problems). Recommended way is passing a lambda to `onDestroyView: (T.() -> Unit)? = null` parameter of extension functions, eg.
```diff
- private val binding by viewBinding()
+ private val binding by viewBinding { /*this: FragmentFirstBinding*/
+ button.setOnClickListener(null)
+ recyclerView.adapter = null
+ }
override fun onDestroyView() {
super.onDestroyView()
- binding.button.setOnClickListener(null)
- binding.recyclerView.adapter = null
}
```
### 5. Min SDK version
Since version `1.2.0`, `minSdkVersion` has been changed to `14`.
## License
MIT License
Copyright (c) 2020-2022 Petrus Nguyễn Thái Học