Add Compose Settings library

Author: JanMalch

app/build.gradle.kts

@@ -62,6 +62,7 @@ dependencies {
     implementation(libs.ui.tooling.preview)
     implementation(libs.material3)
     implementation(libs.bundles.datastore)
+    implementation(libs.bundles.settings)
     testImplementation(libs.junit)
     androidTestImplementation(libs.androidx.test.ext.junit)
     androidTestImplementation(libs.espresso.core)

app/src/main/java/io/github/janmalch/composeprotosettings/MainActivity.kt

@@ -10,6 +10,7 @@ import androidx.compose.material3.Text
 import androidx.compose.runtime.Composable
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.tooling.preview.Preview
+import io.github.janmalch.composeprotosettings.ui.preference.AppSettings
 import io.github.janmalch.composeprotosettings.ui.theme.ComposeProtoSettingsTheme
 
 class MainActivity : ComponentActivity() {
@@ -22,7 +23,7 @@ class MainActivity : ComponentActivity() {
                     modifier = Modifier.fillMaxSize(),
                     color = MaterialTheme.colorScheme.background
                 ) {
-                    Greeting("Android")
+                    AppSettings()
                 }
             }
         }

app/src/main/java/io/github/janmalch/composeprotosettings/ui/preference/AppSettings.kt

@@ -0,0 +1,45 @@
+package io.github.janmalch.composeprotosettings.ui.preference
+
+import androidx.compose.material.icons.Icons
+import androidx.compose.material.icons.filled.Settings
+import androidx.compose.material3.Icon
+import androidx.compose.material3.Text
+import androidx.compose.runtime.Composable
+import androidx.compose.ui.tooling.preview.Preview
+import com.alorma.compose.settings.storage.base.rememberBooleanSettingState
+import com.alorma.compose.settings.storage.datastore.proto.rememberProtoDataStoreSettingState
+import com.alorma.compose.settings.storage.datastore.proto.rememberProtoDataStoreState
+import com.alorma.compose.settings.storage.datastore.proto.rememberProtoDataStoreTransformSettingState
+import com.alorma.compose.settings.ui.SettingsCheckbox
+import io.github.janmalch.composeprotosettings.preferences.UserPreferencesSerializer
+import io.github.janmalch.composeprotosettings.preferences.copy
+import io.github.janmalch.composeprotosettings.ui.theme.ComposeProtoSettingsTheme
+
+@Composable
+fun AppSettings() {
+    val dataStoreState = rememberProtoDataStoreState(
+        // "filename" is optional, but it is recommended to set the protobuf file name so that it wouldn't conflict with other datastore definition.
+        filename = "compose_settings_datastore_proto.pb",
+        serializer = UserPreferencesSerializer,
+    )
+    val state = rememberProtoDataStoreTransformSettingState(
+        protoDataStoreState = dataStoreState,
+        encoder = { saved, newValue -> saved.copy { showCompleted = newValue } },
+        decoder = { it.showCompleted }
+    )
+
+    SettingsCheckbox(
+        state = state,
+        icon = { Icon(imageVector = Icons.Default.Settings, contentDescription = "Wifi") },
+        title = { Text(text = "Hello") },
+        subtitle = { Text(text = "This is a longer text") },
+    )
+}
+
+@Preview(showBackground = true)
+@Composable
+fun AppSettingsPreview() {
+    ComposeProtoSettingsTheme {
+        AppSettings()
+    }
+}

gradle/libs.versions.toml

@@ -11,6 +11,7 @@ compose-bom = "2023.06.01"
 datastore = "1.0.0"
 protobuf = "3.23.2" # "3.23.3" is broken
 protobuf-plugin = "0.9.3"
+compose-settings = "0.27.0" # https://central.sonatype.com/artifact/com.github.alorma/compose-settings-ui-m3/0.27.0, https://github.com/alorma/Compose-Settings
 
 [libraries]
 core-ktx = { group = "androidx.core", name = "core-ktx", version.ref = "core-ktx" }
@@ -33,6 +34,8 @@ protobuf-java = { group = "com.google.protobuf", name = "protobuf-javalite", ver
 protobuf-kotlin = { group = "com.google.protobuf", name = "protobuf-kotlin-lite", version.ref = "protobuf" }
 protoc = { group = "com.google.protobuf", name = "protoc", version.ref = "protobuf" }
 
+compose-settings-ui = { group = "com.github.alorma", name = "compose-settings-ui-m3", version.ref = "compose-settings" }
+compose-settings-proto = { group = "com.github.alorma", name = "compose-settings-storage-datastore-proto", version.ref = "compose-settings" }
 
 [plugins]
 com-android-application = { id = "com.android.application", version.ref = "agp" }
@@ -41,3 +44,4 @@ com-google-protobuf = { id = "com.google.protobuf", version.ref = "protobuf-plug
 
 [bundles]
 datastore = ["datatore", "protobuf-java", "protobuf-kotlin"]
+settings = ["compose-settings-ui", "compose-settings-proto"]