Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/maxr1998/modernandroidpreferences
Android Preferences defined through Kotlin DSL, shown in a RecyclerView
https://github.com/maxr1998/modernandroidpreferences
android android-library kotlin kotlin-android kotlin-dsl preferences
Last synced: 9 days ago
JSON representation
Android Preferences defined through Kotlin DSL, shown in a RecyclerView
- Host: GitHub
- URL: https://github.com/maxr1998/modernandroidpreferences
- Owner: Maxr1998
- License: apache-2.0
- Created: 2018-09-16T15:29:20.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-21T14:36:48.000Z (18 days ago)
- Last Synced: 2024-10-22T00:17:52.902Z (17 days ago)
- Topics: android, android-library, kotlin, kotlin-android, kotlin-dsl, preferences
- Language: Kotlin
- Homepage:
- Size: 2.23 MB
- Stars: 119
- Watchers: 4
- Forks: 5
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# ModernAndroidPreferences
[](https://github.com/Maxr1998/ModernAndroidPreferences/releases)
[](https://repo.maven.apache.org/maven2/de/maxr1998/modernandroidpreferences/)
[](https://github.com/Maxr1998/ModernAndroidPreferences/actions/workflows/library-test.yaml)
[](https://github.com/Maxr1998/ModernAndroidPreferences/actions/workflows/library-lint.yaml)
[](https://github.com/Maxr1998/ModernAndroidPreferences/blob/master/LICENSE)
Android preferences in Kotlin DSL, displayed in a RecyclerView.
_No XML, no troubles with PreferenceManager, Fragments, or styling, no more ListView._ :tada:
### Code example
```Kotlin
// Setup a preference screen
val screen = screen(context) {
pref("first") {
title = "A preference"
summary = "Click me to do stuff"
click {
doStuff()
}
}
pref("second") {
title = "Another one"
iconRes = R.drawable.preference_icon_24dp
}
categoryHeader("more") {
titleRes = R.string.category_more
}
switch("toggle_feature") {
title = "Also supports switches"
}
// and many other preference widgets!
}
// Wrap the created screen in a preference adapter…
val preferencesAdapter = PreferencesAdapter(screen)
// …that can be attached to a RecyclerView
recyclerView.adapter = preferencesAdapter
```
### Example app
Example Activities ([with](https://github.com/Maxr1998/ModernAndroidPreferences/tree/master/testapp/src/main/java/de/Maxr1998/modernpreferences/example/view_model) and [without](https://github.com/Maxr1998/ModernAndroidPreferences/blob/master/testapp/src/main/java/de/Maxr1998/modernpreferences/example/TestActivity.kt) using ViewModel)
show advanced info like back handling, saving/restoring scroll position, and using the `OnScreenChangeListener`.
### Screenshots
Click to show
|  |  |
|:---------------------------------:|:---------------------------------:|
## Include to project
ModernAndroidPreferences is on [Maven Central](https://search.maven.org/artifact/de.maxr1998/modernandroidpreferences),
so you can get it like any other dependency:
```gradle
dependencies {
implementation 'de.maxr1998:modernandroidpreferences:2.3.2'
}
```
---
**NOTE:** This library has previously been available as `de.Maxr1998.android:modernpreferences` on Bintray JCenter,
but was migrated to Sonatype Maven Central in light of the impending JCenter sunsetting.
To get in line with Maven naming standards, it was renamed to `de.maxr1998:modernandroidpreferences`.
## License
Copyright © 2018-2021 Max Rumpf alias Maxr1998
This library is released under the Apache License version 2.0.
If you use this library (or code from it) in your projects, crediting me is appreciated.
The example application however is licensed under the GNU General Public version 3, or any later version.