KotPreferences
4.0.0indexedSimplifies preference management with a fluent API, supporting custom data objects, default values, and type safety for streamlined configuration handling.
10
Stars
4
Used by
dependents
—
Health
/ 100
KotPreferences
This library provides following main features:
- declare preferences via kotlin delegates
- listen to updates from preferences via
kotlin flows - update dependencies via
suspendfunctions - use those preferences inside compose as
State,MutableStateorStateFlow
Table of Contents
:computer: Supported Platforms
:arrow_right: Versions
| Dependency | Version |
|---|---|
| Kotlin | 2.4.0 |
| Jetbrains Compose | 1.11.1 |
:warning: Following experimental annotations are used:
- OptIn
kotlinx.cinterop.ExperimentalForeignApi(3x)I try to use as less experimental features as possible, but in this case the ones above are needed!
:wrench: Setup
Direct Dependency Notation
Simply add the dependencies inside your build.gradle.kts file.
:rocket: Usage
1. Define a SettingsModel
2a) Use the SettingsModel in plain kotlin (flows + suspending functions)
// 1) get a flow
val flow = Preferences.someString.flow
// 2) read/update values by suspend functions
scope.launch(Dispatchers.IO) {
val value = Preferences.someInt.read()
Preferences.someInt.update(value + 1)
}
2b) Use the SettingsModel in views (e.g. with Lifecycle Scope)
2c) Use the SettingsModel in compose
val name = Preferences.someString.collectAsState()
val name = Preferences.someString.collectAsStateWithLifecycle()
// simply use the state inside your composables, the state will change whenever the setting behind it will change
val name = Preferences.someString.asMutableState()
// simple use and even update the state now
:file_folder: Modules
:sparkles: Demo
A full demo is included inside the demo module, it shows nearly every usage with working examples.
:information_source: More
:books: API
Check out the API documentation.
:bulb: Other Libraries
You can find more libraries (all multiplatform) of mine that all do work together nicely here.