Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ehsannarmani/easyshared
A Library For Using SharedPreferences Easier
https://github.com/ehsannarmani/easyshared
android android-library android-studio database easy java kotlin kotlin-android kotlin-library library mobile-development shared-preferences sharedpreferences
Last synced: 3 days ago
JSON representation
A Library For Using SharedPreferences Easier
- Host: GitHub
- URL: https://github.com/ehsannarmani/easyshared
- Owner: ehsannarmani
- Created: 2023-11-09T17:30:29.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-03-30T20:16:49.000Z (10 months ago)
- Last Synced: 2024-03-30T21:24:19.689Z (10 months ago)
- Topics: android, android-library, android-studio, database, easy, java, kotlin, kotlin-android, kotlin-library, library, mobile-development, shared-preferences, sharedpreferences
- Language: Kotlin
- Homepage:
- Size: 116 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# EasyShared
### A Library For Using Shared Preferences Easier
## Usage:
```kotlin
var token:String by savable("auth_token")
var age:Int by savable() /* savable("age") */
var loggedIn:Boolean by savable() /* savable("loggedIn") */
var phone by savableInt()
var name by savableString()
var timestamp by savableLong()
```
#### Note: you can pass variable key to save in shared preferences, but if you don't, it will save in variable name, for exmaple:
```kotlin
var username:String by savable()
```
#### Here, that username will save in 'username' key, and:
```kotlin
var username:String by savable("name")
```
#### Here, that username will save in 'user' key
### Updating
#### For update and re-save variable value in shared prefrences, just update that savable value, that's it! , for example:
```kotlin
var token:String by savable("auth_token")
token = "xxxxx"
```
```kotlin
var userId by savableInt()
userId = 43
```
#### No need to do anything else.
### Saving Objects & ListOf Them
```kotlin
data class Person(val id:Int,val name:String)
val persons:List by savable(defauleValue = emptyList())
```
## Final Sample In Jetpack Compose:
```kotlin
var token:String by savable("auth_token")
var user:User by savable(defaultValue = User(id = -1,name = "empty user"))
Button(onClick = {
token = UUID.randomUUID().toString()
user = User(id = 342, name = "Iran")
}) {
Text(text = "Set")
}
Button(onClick = {
println(user.name)
Toast.makeText(context, token, Toast.LENGTH_SHORT).show()
}) {
Text(text = "Get")
}
```
## Dependency
### Add the JitPack repository to your build file
#### Add Jitpack Maven in your settings.gradle file:
```groovy
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}
```
#### Kotlin DSL(build.gradle.kts):
```kotlin
repositories {
...
maven("https://jitpack.io")
}
```
## Add the dependency
[](https://jitpack.io/#ehsannarmani/EasyShared)
#### Groovy:
```groovy
dependencies {
implementation 'com.github.ehsannarmani:EasyShared:latest_version'
}
```
#### Kotlin DSL (build.gradle.kts):
```groovy
dependencies {
implementation("com.github.ehsannarmani:EasyShared:latest_version")
}
```