https://github.com/guilhe/resourcesprovider-ktx
Helper class to provide resources - ContextCompat, ResourcesCompat, AnimationUtils, Context.resources - all in one place! 🤩🥳
https://github.com/guilhe/resourcesprovider-ktx
android-resources kotlin-and kotlin-android kotlin-android-extensions kotlin-extensions
Last synced: 24 days ago
JSON representation
Helper class to provide resources - ContextCompat, ResourcesCompat, AnimationUtils, Context.resources - all in one place! 🤩🥳
- Host: GitHub
- URL: https://github.com/guilhe/resourcesprovider-ktx
- Owner: GuilhE
- License: apache-2.0
- Created: 2019-10-12T00:44:20.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-08-29T17:18:38.000Z (over 2 years ago)
- Last Synced: 2025-04-04T03:41:15.466Z (about 2 months ago)
- Topics: android-resources, kotlin-and, kotlin-android, kotlin-android-extensions, kotlin-extensions
- Language: Kotlin
- Homepage: https://guilhe.github.io/ResourcesProvider-ktx/
- Size: 621 KB
- Stars: 15
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# ResourcesProvider-ktx
[](https://travis-ci.org/GuilhE/ResourcesProvider-ktx) [](https://android-arsenal.com/details/1/7921)
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](https://search.maven.org/artifact/com.github.guilhe/resources-provider-ktx) and [Jitpack](https://jitpack.io/#GuilhE/ResourcesProvider-ktx).
```groovy
implementation 'com.github.guilhe:resources-provider-ktx:${LATEST_VERSION}'
```
[](https://search.maven.org/search?q=g:com.github.guilhe%20AND%20resources-provider-ktx)
## Usage
### Resources types
```kotlin
text(@StringRes resId: Int): CharSequence
textArray(@ArrayRes resId: Int): Array
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
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`:
```kotlin
.setBackgroundColor(resourcesProvider.colorRes(R.attr.colorPrimary, R.style.App_Style_A)
```
by `@ColorInt`:
```kotlin
.setColor(resourcesProvider.color(R.attr.colorPrimary, R.style.App_Style_B))
```
by `ColorStateList`:
```kotlin
.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`:
```kotlin
.foreground = resourcesProvider.drawableFromAttr(android.R.attr.selectableItemBackground, R.style.App)
```
### Setup
By Kotlin Extensions (View, Activity, Fragment):
```kotlin
class Activity : AppCompatActivity(){
fun work() {
resourcesProvider().string(R.string.app_name_label)
}
}
```
By Dependency Injection (ex: `Dagger`):
Add to your dependencies graph:
```kotlin
@JvmStatic
@Provides
@Singleton
fun provideResourcesProvider(context: YourApp): ResourcesProvider{
return ResourcesProvider(context)
}
```
Use it:
```kotlin
//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
- [androidx.core:core-ktx](https://developer.android.com/jetpack/androidx/releases/core)
- [androidx.fragment:fragment-ktx](https://developer.android.com/jetpack/androidx/releases/fragment)
## Bugs and Feedback
For bugs, questions and discussions please use the [Github Issues](https://github.com/GuilhE/ResourcesProvider-ktx/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
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.