Enhances AndroidX DataStore with type safety, eliminating string keys by representing preferences as objects. Supports SharedPreferences encryption and simplifies preference declaration and usage.
settings-multiplatform provides a type-safe, multiplatform abstraction over AndroidX DataStore, letting you define preferences as objects (rather than string keys), and enabling encryption.
[!NOTE] Settings Multiplatform now support Encryption in version 2.3.0+
Working with DataStore typically means you operate with string keys and primitive types, which is error-prone and lacks compile-time safety. When you migrate logic to a multiplatform structure (Android + iOS / Kotlin Multiplatform), managing platform-specific preferences becomes cumbersome.
settings-multiplatform solves these issues by:
stringPreference, intPreference) instead of raw string keysPreferences.preferenceString instead of "preference_string"Add the library to your module build.gradle
dependencies {
implementation 'de.charlex.settings:settings-datastore:<version>'
}
val settingsDatastore = SettingsDataStore.create(
context = context,
name = "multiplatform-datastore.preferences_pb",
encryptedStore = {
AESEncryptedStore(it)
}
)
val settingsDatastore = SettingsDataStore.create(
name = "multiplatform-datastore.preferences_pb",
encryptedStore = {
KeychainStore(
dataStore = it,
keychain = Keychain(
appGroup = "group.xxx",
service = NSBundle.mainBundle.bundleIdentifier
)
)
}
)
//Read
val exampleString: Flow<String> = settingsDatastore.get(Preferences.PreferenceString)
val encryptedExampleString: Flow<String> = settingsDatastore.get(EncryptedPreferences.encryptedPreferenceString)
//Write
coroutineScope.launch {
settings.put(Preferences.preferenceString, "my value")
settings.put(EncryptedPreferences.encryptedPreferenceString, "shoulb be encrypted")
}
Copyright 2024 Alexander Karkossa
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance the License.
You may obtain a copy of the License at
http:
Unless applicable law agreed to writing, software
distributed under the License distributed an BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express implied.
See the License the specific language governing permissions
limitations under the License.
Surfaced from shared tags and platforms — no rankings paid for.
object Preferences {
val preferenceInt = intPreference("preference_int", 1)
val preferenceString = stringPreference("preference_string", "default")
val preferenceFloat = floatPreference("preference_float", 1.1f)
val preferenceLong = longPreference("preference_long", 1L)
val preferenceBoolean = boolenPreference("preference_boolean", true)
}
object EncryptedPreferences {
val encryptedPreferenceInt = encryptedIntPreference("encrypted_preference_int", 1)
val encryptedPreferenceString = encryptedStringPreference("encrypted_preference_string", "default")
val encryptedPreferenceFloat = encryptedFloatPreference("encrypted_preference_float", 1.1f)
val encryptedPreferenceLong = encryptedLongPreference("encrypted_preference_long", 1L)
val encryptedPreferenceBoolean = encryptedBoolenPreference("encrypted_preference_boolean", true)
}