ResourcesProvider-ktx

Additional

Language
Kotlin
Version
v1.3.2 (Sep 9, 2020)
Created
Oct 12, 2019
Updated
Oct 2, 2020
Owner
GuilhE
Contributors
GuilhE
GuilhE@Bliss (gdelgadobliss)
2
Activity
Badge
Generate
Download
Source code

Announcement

ResourcesProvider-ktx

Need a resource but don't remember where to get it from: ContextCompat, ResourcesCompat, AnimationUtils, Context.resources? Fear no more, this lib puts them all in one place! 🤩🥳

Installation

ResourcesProvider-ktx is distributed through Maven Central, Jcenter and Jitpack.

implementation 'com.github.guilhe:resources-provider-ktx:${LATEST_VERSION}'

Usage

Resources types

text(@StringRes resId: Int): CharSequence
textArray(@ArrayRes resId: Int): Array<CharSequence>
quantityText(@PluralsRes resId: Int, quantity: Int): CharSequence
string(@StringRes resId: Int): String
string(@StringRes resId: Int, vararg formatArgs: Any): String
stringArray(@ArrayRes resId: Int): Array<String>
quantityString(@PluralsRes resId: Int, quantity: Int): String
quantityString(@PluralsRes resId: Int, quantity: Int, vararg formatArgs: Any): String
integer(@IntegerRes resId: Int): Int
intArray(@ArrayRes resId: Int): IntArray
boolean(@BoolRes resId: Int): Boolean
dimension(@DimenRes resId: Int): Float
dimensionPixelSize(@DimenRes resId: Int): Int
dimensionPixelOffset(@DimenRes resId: Int): Int
drawable(@DrawableRes resId: Int): Drawable?
drawable(@DrawableRes id: Int, @StyleRes themeResId: Int): Drawable?
drawableFromAttr(@AttrRes attrResId: Int, @StyleRes themeResId: Int): Drawable?
drawableForDensity(@DrawableRes id: Int, @StyleRes themeResId: Int, density: Int): Drawable?
color(@ColorRes resId: Int): Int
color(@AttrRes attrResId: Int, @StyleRes themeResId: Int): Int
colorRes(@AttrRes attrResId: Int, @StyleRes themeResId: Int): Int
colorStateList(@ColorRes resId: Int): ColorStateList?
colorStateList(@ColorRes id: Int, @StyleRes themeResId: Int): ColorStateList?
colorStateListFromAttr(@AttrRes attrResId: Int, @StyleRes themeResId: Int): ColorStateList
font(@FontRes id: Int): Typeface?
loadAnimation(@AnimRes id: Int): Animation
resolveAttribute(@AttrRes id: Int, outValue: TypedValue, resolveRefs: Boolean): Boolean
resolveAttribute(@AttrRes id: Int, @StyleRes themeResId: Int, outValue: TypedValue, resolveRefs: Boolean): Boolean
value(@DimenRes id: Int, resolveRefs: Boolean): TypedValue
identifier(name: String, defType: String, defPackage: String): Int

Themes

You can also easily change themed attributes as the following examples:

by @ColorRes:

.setBackgroundColor(resourcesProvider.colorRes(R.attr.colorPrimary, R.style.App_Style_A)

by @ColorInt:

.setColor(resourcesProvider.color(R.attr.colorPrimary, R.style.App_Style_B))

by ColorStateList:

.backgroundTintList = resourcesProvider.colorStateListFromAttr(R.attr.colorPrimary, R.style.App_Style_C)
.backgroundTintList = resourcesProvider.colorStateList(R.color.color_selector, R.style.App_Style_C)

by drawableFromAttr:

.foreground = resourcesProvider.drawableFromAttr(android.R.attr.selectableItemBackground, R.style.App)

Setup

By Kotlin Extensions (View, Activity, Fragment):

class Activity : AppCompatActivity(){
    fun work() {
        resourcesProvider().string(R.string.app_name_label)
    }
}

By Dependency Injection (ex: Dagger): Add to your dependencies graph:

@JvmStatic
@Provides
@Singleton
fun provideResourcesProvider(context: YourApp): ResourcesProvider{
    return ResourcesProvider(context)
}

Use it:

//by constructor injection
class MyClass @Inject constructor(resourcesProvider: ResourcesProvider)

//by field injection
@Inject
protected lateinit var resourcesProvider: ResourcesProvider

fun work(){
    resourcesProvider.color(R.color.color_1)
}

Done! 😎

Dependencies

Bugs and Feedback

For bugs, questions and discussions please use the Github Issues.

LICENSE

Copyright (c) 2019-present GuilhE

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.