Settings Multiplatform

settings-multiplatform provides a type-safe, multiplatform abstraction over AndroidX DataStore, letting you define preferences as objects (rather than string keys), and optionally enabling encryption.

Note

Settings Multiplatform now support Encryption in version 2.1.0-beta02

🔍 What it solves

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:

• Exposing preference definitions as typed objects (e.g. stringPreference, intPreference) instead of raw string keys
• Handling both Android and iOS usage through a shared API
• Optionally supporting encrypted preferences on supported platforms

🛠 Key Features

• ✅ Type safety: No more string key typos — you reference Preferences.preferenceString instead of "preference_string"
• ✅ Simple usage API, same interface across platforms
• ✅ Optional encryption layer (Android & iOS) for sensitive settings

Dependency

Add the library to your module build.gradle

dependencies {
    implementation 'de.charlex.settings:settings-datastore:<version>'
    implementation 'de.charlex.settings:settings-datastore-encryption:<version>'
}

Usage

Declaring Preferences

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)
}

Using Preferences

src@android

val settingsDatastore = SettingsDataStore.create(
  context = context,
  name = "multiplatform-datastore.preferences_pb",
  security = AESSecurity //Optional
)

src@ios

val settingsDatastore = SettingsDataStore.create(
  name = "multiplatform-datastore.preferences_pb",
  security = AESSecurity //Optional
)

Usage

//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")
}

License

Copyright 2024 Alexander Karkossa

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.