Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/chibatching/Kotpref

Kotpref - Android SharedPreferences delegation library for Kotlin
https://github.com/chibatching/Kotpref

android kotlin sharedpreferences

Last synced: about 2 months ago
JSON representation

Kotpref - Android SharedPreferences delegation library for Kotlin

Awesome Lists containing this project

README 

        
# Kotpref



Android SharedPreference delegation for Kotlin.



[![kotlin](https://img.shields.io/badge/kotlin-1.4.10-blue.svg)]() [![codecov](https://codecov.io/gh/chibatching/Kotpref/branch/master/graph/badge.svg)](https://codecov.io/gh/chibatching/Kotpref) [![license](https://img.shields.io/github/license/chibatching/Kotpref.svg?maxAge=2592000)]()



## Install



```groovy

repositories {

    mavenCentral()

}



dependencies {

    // core

    implementation 'com.chibatching.kotpref:kotpref:2.13.1'

  

    // optional, auto initialization module

    implementation 'com.chibatching.kotpref:initializer:2.13.1'

  

    // optional, support saving enum value and ordinal

    implementation 'com.chibatching.kotpref:enum-support:2.13.1'

  

    // optional, support saving json string through Gson

    implementation 'com.chibatching.kotpref:gson-support:2.13.1'

    implementation 'com.google.code.gson:gson:2.8.6'

  

    // optional, support LiveData observable preference

    implementation 'com.chibatching.kotpref:livedata-support:2.13.1'

    implementation 'androidx.lifecycle:lifecycle-livedata:2.2.0'



    // experimental, preference screen build dsl

    implementation 'com.chibatching.kotpref:preference-screen-dsl:2.13.1'

}

```



## How to use



### Declare preference model



```kotlin

object UserInfo : KotprefModel() {

    var name by stringPref()

    var code by nullableStringPref()

    var age by intPref(default = 14)

    var highScore by longPref()

    var rate by floatPref()

    val prizes by stringSetPref {

        val set = TreeSet()

        set.add("Beginner")

        return@stringSetPref set

    }

}



enum class GameLevel {

    EASY,

    NORMAL,

    HARD

}

```



### Set up



Pass the application context to Kotpref



```kotlin

Kotpref.init(context)

```



or use auto initializer module.



### Injectable Context



If you don't want to use singleton context because of unit test or etc.., you can use secondary 

constructor of KotprefModel to inject context.  



```kotlin

class InjectableContextSamplePref(context: Context) : KotprefModel(context) {

    var sampleData by stringPref()

}

```



If you set context to all your model, you don't need call `Kotpref.init(context)` and don't use auto initializer module.



### Read and Write



```kotlin

UserInfo.gameLevel = GameLevel.HARD

UserInfo.name = "chibatching"

UserInfo.code = "DAEF2599-7FC9-49C5-9A11-3C12B14A6898"

UserInfo.age = 30

UserInfo.highScore = 49219902

UserInfo.rate = 49.21F

UserInfo.prizes.add("Bronze")

UserInfo.prizes.add("Silver")

UserInfo.prizes.add("Gold")



Log.d(TAG, "Game level: ${UserInfo.gameLevel}")

Log.d(TAG, "User name: ${UserInfo.name}")

Log.d(TAG, "User code: ${UserInfo.code}")

Log.d(TAG, "User age: ${UserInfo.age}")

Log.d(TAG, "User high score: ${UserInfo.highScore}")

Log.d(TAG, "User rate: ${UserInfo.rate}")

UserInfo.prizes.forEachIndexed { i, s -> Log.d(TAG, "prize[$i]: $s") }

```



### Bulk edit



```kotlin

UserInfo.bulk {

    gameLevel = GameLevel.EASY

    name = "chibatching Jr"

    code = "451B65F6-EF95-4C2C-AE76-D34535F51B3B"

    age = 2

    highScore = 3901

    rate = 0.4F

    prizes.clear()

    prizes.add("New Born")

}



// Bulk edit uses Editor#apply() method internally.

// If you want to apply immediately, you can use blockingBulk instead.

UserInfo.blockingBulk {

    gameLevel = GameLevel.EASY

}

```



### Result shared preference xml



XML file name equals model class name. If model class named `UserInfo`, XML file name is `UserInfo.xml`.



```xml



    

    

        Beginner

        Bronze

        Gold

        Silver

    

    chibatching

    DAEF2599-7FC9-49C5-9A11-3C12B14A6898

    

    



```



### Options



#### Change default value



```kotlin

var age: Int by intPref(18)

```



or



```kotlin

var age: Int by intPref(default = 18)

```



#### Change preference key



You can custom preference key or use from string resources.



```kotlin

var useFunc1: Boolean by booleanPref(key = "use_func1")

var mode: Int by intPref(default = 1, key = R.string.pref_mode)

```



#### Change default save mode



Kotpref save all preference property by `apply` method.

You can change method to `commit` for each property.



```kotlin

var age: Int by intPref(default = 18, commitByDefault = true)

```



Or change default for each KotprefModel.



```kotpref

object UserInfo : KotprefModel() {

    override val commitAllPropertiesByDefault: Boolean = true

```



#### Change XML file name



Override `kotprefName` property.



```kotlin

object UserInfo : KotprefModel() {

    override val kotprefName: String = "user_info"

```



#### Change SharedPreference mode



Override `kotprefMode` property. Default is `Context.MODE_PRIVATE`.



```kotlin

object UserInfo : KotprefModel() {

    override val kotprefMode: Int = Context.MODE_MULTI_PROCESS

```



## API Docs



[https://chibatching.github.io/Kotpref/docs/api/-modules.html](https://chibatching.github.io/Kotpref/docs/api/-modules.html)



## License



```

Copyright 2015-2021 Takao Chiba



   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.

```