Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nsk-mironov/kotlin-jetpack
A collection of useful extension methods for Android
https://github.com/nsk-mironov/kotlin-jetpack
Last synced: about 2 months ago
JSON representation
A collection of useful extension methods for Android
- Host: GitHub
- URL: https://github.com/nsk-mironov/kotlin-jetpack
- Owner: nsk-mironov
- License: apache-2.0
- Archived: true
- Created: 2015-09-28T00:13:14.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-10-18T15:58:22.000Z (almost 7 years ago)
- Last Synced: 2024-04-02T18:34:20.973Z (6 months ago)
- Language: Kotlin
- Homepage:
- Size: 204 KB
- Stars: 184
- Watchers: 3
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-kotlin-android - kotlin-jetpack
- awesome-kotlin-libraries-for-android - Kotlin Jetpack - A collection of useful extension methods for Android. (<a name="utility"></a>Utility <sup>[Back ⇈](#contents)</sup>)
- trackawesomelist - nsk-mironov/kotlin-jetpack (⭐184)
README
# Kotlin Jetpack [](https://android-arsenal.com/details/1/2588)
A collection of useful extension methods for Android
* [Arguments Bindings](#arguments-bindings)
* [Preferences Bindings](#preferences-bindings)
* [Resources Bindings](#resources-bindings)
# Arguments Bindings
```kotlin
public class ArgumentsFragment : Fragment() {
public companion object {
public fun newInstance(): ArgumentsFragment = ArgumentsFragment().apply {
arguments = Bundle().apply {
putBoolean("extra_boolean", true)
}
}
}
// Required binding without default value
val booleanOrThrow by bindArgument("extra_boolean")
// Required binding with default value
val booleanOrDefault by bindArgument("extra_boolean", false)
// Optional binding
val booleanOrNull by bindOptionalArgument("extra_boolean")
}
```
These methods can be used with `Activity`, `Fragment`, and support library `Fragment` subclasses. You can also implement `ArgumentsAware` interface to provide a custom arguments source. Full list of supported bindings:
- `bindArgument` / `bindOptionalArgument`
- `bindArgument` / `bindOptionalArgument`
- `bindArgument` / `bindOptionalArgument`
- `bindArgument` / `bindOptionalArgument`
- `bindArgument` / `bindOptionalArgument`
- `bindArgument` / `bindOptionalArgument`
- `bindArgument` / `bindOptionalArgument`
- `bindArgument` / `bindOptionalArgument`
- `bindArgument` / `bindOptionalArgument`
- `bindArgument` / `bindOptionalArgument`
Every `bindXXXArgument` returns a `ReadWriteProperty` so they can be used with `var`'s as well. In this case you don't have to deal with `Bundle` at all. No explicit `Bundle` creation, no silly `EXTRA_XXX` constants, no annoying `Bundle.putXXX` and `Bundle.getXXX` calls. Everything just works:
```kotlin
public class UserProfileFragment : Fragment() {
public companion object {
public fun newInstance(): UserProfileFragment = UserProfileFragment().apply {
this.firstName = "Vladimir"
this.lastName = "Mironov"
}
}
// extra name is automatically inferred from property name ("firstName" in this case)
var firstName by bindArgument()
// you can also provide a default value using "default" named argument
var lastName by bindArgument(default = "")
}
```
Gradle dependency:
```gradle
compile "com.github.vmironov.jetpack:jetpack-bindings-arguments:0.14.2"
```
# Preferences Bindings
```kotlin
public class PreferencesFragment : Fragment() {
// Boolean preference
var boolean by bindPreference("boolean", false)
// Float preference
var float by bindPreference("float", 0.0f)
// Integer preference
var integer by bindPreference("integer", 1)
// Long preference
var long by bindPreference("long", 1L)
// String preference
var string by bindPreference("string", "default")
}
```
These methods can be used with `Context`, `Fragment`, support library `Fragment`, `View`, and `ViewHolder` subclasses. The example above uses a default `SharedPreferences` instance. You can always provide a custom one by implementing `PreferencesAware` interface:
```kotlin
public class PreferencesFragment : Fragment() {
val preferences = PreferencesAware {
activity.getSharedPreferences("CustomSharedPreferences", Context.MODE_PRIVATE)
}
var boolean by preferences.bindPreference("boolean", false)
var float by preferences.bindPreference("float", 0.0f)
var integer by preferences.bindPreference("integer", 1)
var long by preferences.bindPreference("long", 1L)
var string by preferences.bindPreference("string", "default")
// Optional preferences are supported as well
var optionalLong by preferences.bindOptionalPreference()
var optionalString by preferences.bindOptionalPreference()
}
```
Although only `Boolean`, `Float`, `Int`, `Long` and `String` preferences are supported by default, the library can be easily extented to support custom type of preference. `Adapter` interface can be implemented in order to convert any type to a supported one. Here is an example how to imlement `json`-based preferences using `Gson`:
```kotlin
public inline fun Any.bindGsonPreference(default: E, key: String? = null): ReadWriteProperty {
return bindPreference(default, GsonPreferenceAdapter(E::class.java), key)
}
public inline fun Any.bindGsonPreference(noinline default: () -> E, key: String? = null): ReadWriteProperty {
return bindPreference(default, GsonPreferenceAdapter(E::class.java), key)
}
public class GsonPreferenceAdapter(val clazz: Class, val gson: Gson = GsonPreferenceAdapter.GSON) : Adapter {
override fun type(): Class = String::class.java
override fun fromPreference(preference: String): T = gson.fromJson(preference, clazz)
override fun toPreference(value: T): String = gson.toJson(value)
public companion object {
public val GSON = Gson()
}
}
```
Usage:
```kotlin
public data class Profile(val firstName: String? = null, val lastName: String? = null)
public class ProfileManager(val context: Context) {
public var profile by bindGsonPreference(Profile())
}
```
Gradle dependency:
```gradle
compile "com.github.vmironov.jetpack:jetpack-bindings-preferences:0.14.2"
```
# Resources Bindings
```kotlin
public class ResourcesFragment : Fragment() {
// Boolean resource binding
val boolean by bindResource(R.boolean.boolean_resource)
// Color resource binding
val color by bindResource(R.color.color_resource)
// Drawable resource binding #1
val bitmap by bindResource(R.drawable.drawable_bitmap)
// Drawable resource binding #2
val vector by bindResource(R.drawable.drawable_vector)
// Dimension resource binding
val dimension by bindResource(R.dimen.dimen_resource)
// String resource binding
val string by bindResource(R.string.string_resource)
}
```
These methods can be used with `Activity`, `Context`, `Fragment`, support library `Fragment`, `View`, and `ViewHolder` subclasses. You can also implement `ResourcesAware` interface to provide a custom resources source. Full list of supported bindings:
- `bindResource(R.boolean.boolean_resource)`
- `bindResource(R.integer.integer_resource)`
- `bindResource(R.color.color_resource)`
- `bindResource(R.color.color_resource)`
- `bindResource(R.drawable.drawable_resource)`
- `bindResource(R.dimen.dimen_resource)`
- `bindResource(R.dimen.dimen_resource)`
- `bindResource(R.string.string_resource)`
- `bindResource(R.string.string_resource)`
- `bindResource(R.array.array_resource)`
- `bindResource>(R.array.array_resource)`
- `bindResource>(R.array.array_resource)`
Gradle dependency:
```gradle
compile "com.github.vmironov.jetpack:jetpack-bindings-resources:0.14.2"
```
# License
Copyright 2015 Vladimir Mironov
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.