https://github.com/ch4rl3x/settings-multiplatform
A Kotlin Multiplatform AndroidX DataStore
https://github.com/ch4rl3x/settings-multiplatform
android datastore datastore-android datastore-preferences ios kotlin-coroutines kotlin-flow kotlin-multiplatform preferences preferences-datastore settings sharedpreferences
Last synced: 5 months ago
JSON representation
A Kotlin Multiplatform AndroidX DataStore
- Host: GitHub
- URL: https://github.com/ch4rl3x/settings-multiplatform
- Owner: ch4rl3x
- License: apache-2.0
- Created: 2024-04-04T18:56:48.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-10-15T18:59:27.000Z (8 months ago)
- Last Synced: 2025-10-16T19:18:19.085Z (8 months ago)
- Topics: android, datastore, datastore-android, datastore-preferences, ios, kotlin-coroutines, kotlin-flow, kotlin-multiplatform, preferences, preferences-datastore, settings, sharedpreferences
- Language: Kotlin
- Homepage:
- Size: 188 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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`
```gradle
dependencies {
implementation 'de.charlex.settings:settings-datastore:'
implementation 'de.charlex.settings:settings-datastore-encryption:'
}
```
## Usage
### Declaring Preferences
```kotlin
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
```kotlin
val settingsDatastore = SettingsDataStore.create(
context = context,
name = "multiplatform-datastore.preferences_pb",
security = AESSecurity //Optional
)
```
#### src@ios
```kotlin
val settingsDatastore = SettingsDataStore.create(
name = "multiplatform-datastore.preferences_pb",
security = AESSecurity //Optional
)
```
#### Usage
```kotlin
//Read
val exampleString: Flow = settingsDatastore.get(Preferences.PreferenceString)
val encryptedExampleString: Flow = 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.