Commit451 / Addendum

Useful Kotlin Extensions for the Android SDK and popular Android Libraries

Addendum

Useful Kotlin Extensions for the Android SDK and popular Android Libraries

Gradle Dependency

Add the jitpack url to the project:

allprojects {
    repositories {
        ...
        maven { url "https://jitpack.io" }
    }
}

then, in your app build.gradle

dependencies {
    implementation "com.github.Commit451.Addendum:addendum:latest.version.here"
    //for design support library
    implementation "com.github.Commit451.Addendum:addendum-design:latest.version.here"
    //for RecyclerView support
    implementation "com.github.Commit451.Addendum:addendum-recyclerview:latest.version.here"
    //for Parceler support
    implementation "com.github.Commit451.Addendum:addendum-parceler:latest.version.here"
    //for ThreeTenABP support
    implementation "com.github.Commit451.Addendum:addendum-threetenabp:latest.version.here"
}

Addendum

The general set of extensions. Covers the base framework and app-compat

Activity

//bind a view in a lazy way, like KotterKnife
val text: TextView by bindView(R.id.first_name)
//or
val text by bindView<TextView>(R.id.first_name)
//get from intent extras
val someString by extra<String>(KEY_STRING)
//toggle fullscreen
flagFullscreen()
val screenHeight = screenHeight()
val screenWidth = screenWidth()
//set screen brightness
brightness()

Context

val color = color(R.color.black)
copyToClipboard("A label", someString)

Fragment

//bind a view in a lazy way, like KotterKnife
val text: TextView by bindView(R.id.first_name)

Intent

//for when it can be null, no needed hasValue check
val someInt = intent.getIntExtra("some_key")
val someFloat = intent.getFloatExtra("float_key")
val someLong = intent.getLongExtra("long_key")
val someDouble = intent.getDoubleExtra("double_key")

String

val span = someHtmlString.htmlToSpanned()

View

view.setHeight(somePixelValue)
//sets view to visible
view.visible()
view.invisible()
view.gone()
//bind a view in a lazy way, like KotterKnife
val text: TextView by bindView(R.id.first_name)

ViewGroup

viewGroup.forEach { view ->
    //do something with each view
}
root.forEachIndexed { i, view ->
    //do something with each view and index
}

ViewPager

viewPager.back()
viewPager.forward()
val isLast = viewPager.isOnLastPage()
val isFirst = viewPager.isOnFirstPage()

Addendum Design

For the design support library

TextInputLayout

//Sets the error if empty, returning true if not empty
val valid = textInputLayout.validateEmpty("Empty not allowed")
val text = textInputLayout.text()

Addendum Parceler

For use with Parceler

val item = intent.getParcelerParcelableExtra("some_key")
intent.putParcelerParcelableExtra("some_key", thing)
val otherItem = bundle.getParcelerParcelableExtra("some_key")
bundle.putParcelerParcelable("some_key", thing)

Addendum RecyclerView

For use with RecyclerView

ViewHolder

//within a view holder...
val string = resources().getString(R.string.some_string)
val context = context()
//bind a view in a lazy way, like KotterKnife
val text: TextView by bindView(R.id.first_name)

Addendum ThreeTenABP

For use with ThreeTenABP

val localDate = Date().toLocalDate()
val localDate = Calendar.getInstance().toLocalDate()
val zonedDateTime = Calendar.getInstance().toZonedDateTime()
val date = LocalDate().toDateAtStartOfDay()

What about Android KTX?

Addendum and Android KTX can be used in parallel, and efforts are made to not duplicate functionality that KTX offers. That being said, the ktx libraries restricted presently to just include Android Platform SDK extensions and AndroidX library extensions and does not include extensions for 3rd party libraries, as Addendum does.

License

Copyright 2018 Commit 451

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.