/ViewBindingPropertyDelegate

Make work with Android View Binding simpler

Primary LanguageKotlinApache License 2.0Apache-2.0

Maven Central

ViewBindingPropertyDelegate

Make work with Android View Binding simpler. The library:

  • manages ViewBinding lifecycle and clears the reference to it to prevent memory leaks
  • eliminates the need to keep nullable references to Views or ViewBindings
  • creates ViewBinding lazily

The library comes in two flavors: with and without reflection. The artifacts are respectively: viewbindingpropertydelegate and viewbindingpropertydelegate-noreflection. Prefer to use the one without reflection for better performance

IMPORTANT: Enable ViewBinding before using the library

Each Gradle module in your project where you need to use ViewBinding must be properly configured. Refer to the official guide on how to do that

Add the library to a project

allprojects {
  repositories {
    mavenCentral()
  }
}

dependencies {
    // reflection-based flavor
    implementation 'com.github.kirich1409:viewbindingpropertydelegate-full:1.5.9'
    
    // reflection-free flavor
    implementation 'com.github.kirich1409:viewbindingpropertydelegate-noreflection:1.5.9'
}

Samples

class ProfileFragment : Fragment(R.layout.profile) {

    // reflection API and ViewBinding.bind are used under the hood
    private val viewBinding: ProfileBinding by viewBinding()

    // reflection API and ViewBinding.inflate are used under the hood
    private val viewBinding: ProfileBinding by viewBinding(createMethod = CreateMethod.INFLATE)

    // no reflection API is used under the hood
    private val viewBinding by viewBinding(ProfileBinding::bind)
}
class ProfileActivity : AppCompatActivity(R.layout.profile) {

    // reflection API is used under the hood
    private val viewBinding: ProfileBinding by viewBinding(R.id.container)

    // no reflection API is used under the hood
    private val viewBinding by viewBinding(ProfileBinding::bind, R.id.container)
}

License

Copyright 2020-2023 Kirill Rozov

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.