Add ImageVector support to the preference datastore ui

datastore-ui/src/main/kotlin/dev/patrickgold/jetpref/datastore/ui/Common.kt

@@ -19,6 +19,7 @@ package dev.patrickgold.jetpref.datastore.ui
 import androidx.annotation.DrawableRes
 import androidx.compose.material.Icon
 import androidx.compose.runtime.Composable
+import androidx.compose.ui.graphics.vector.ImageVector
 import androidx.compose.ui.res.painterResource
 
 @Composable
@@ -38,3 +39,21 @@ internal fun maybeJetIcon(
         else -> null
     }
 }
+
+@Composable
+internal fun maybeJetIcon(
+    imageVector: ImageVector?,
+    iconSpaceReserved: Boolean,
+    contentDescription: String? = null,
+): @Composable (() -> Unit)? {
+    return when {
+        imageVector != null -> ({
+            Icon(
+                imageVector = imageVector,
+                contentDescription = contentDescription,
+            )
+        })
+        iconSpaceReserved -> ({ })
+        else -> null
+    }
+}

datastore-ui/src/main/kotlin/dev/patrickgold/jetpref/datastore/ui/DialogSliderPreference.kt

@@ -16,7 +16,6 @@
 
 package dev.patrickgold.jetpref.datastore.ui
 
-import androidx.annotation.DrawableRes
 import androidx.compose.foundation.clickable
 import androidx.compose.foundation.layout.Arrangement
 import androidx.compose.foundation.layout.Column
@@ -50,7 +49,7 @@ import kotlin.math.roundToLong
 internal fun <T : PreferenceModel, V> PreferenceUiScope<T>.DialogSliderPreference(
     pref: PreferenceData<V>,
     modifier: Modifier,
-    @DrawableRes iconId: Int?,
+    icon: JetIcon,
     iconSpaceReserved: Boolean,
     title: String,
     valueLabel: @Composable (V) -> String,
@@ -84,7 +83,7 @@ internal fun <T : PreferenceModel, V> PreferenceUiScope<T>.DialogSliderPreferenc
                         isDialogOpen.value = true
                     }
                 ),
-            icon = maybeJetIcon(iconId, iconSpaceReserved),
+            icon = icon.getIcon(iconSpaceReserved),
             text = title,
             secondaryText = summary(prefValue),
             enabled = isEnabled,
@@ -139,7 +138,7 @@ internal fun <T : PreferenceModel, V> PreferenceUiScope<T>.DialogSliderPreferenc
     primaryPref: PreferenceData<V>,
     secondaryPref: PreferenceData<V>,
     modifier: Modifier,
-    @DrawableRes iconId: Int?,
+    icon: JetIcon,
     iconSpaceReserved: Boolean,
     title: String,
     primaryLabel: String,
@@ -179,7 +178,7 @@ internal fun <T : PreferenceModel, V> PreferenceUiScope<T>.DialogSliderPreferenc
                         isDialogOpen.value = true
                     }
                 ),
-            icon = maybeJetIcon(iconId, iconSpaceReserved),
+            icon = icon.getIcon(iconSpaceReserved = iconSpaceReserved),
             text = title,
             secondaryText = summary(primaryPrefValue, secondaryPrefValue),
             enabled = isEnabled,
@@ -262,7 +261,7 @@ internal fun <T : PreferenceModel, V> PreferenceUiScope<T>.DialogSliderPreferenc
  *
  * @param pref The integer preference data entry from the datastore.
  * @param modifier Modifier to be applied to the underlying list item.
- * @param iconId The icon ID of the list entry icon.
+ * @param icon The [JetIcon] of the list entry.
  * @param iconSpaceReserved If the space at the start of the list item should be reserved (blank
  *  space) if no icon ID is provided.
  * @param title The title of this preference, shown as the list item primary text (max 1 line).
@@ -289,7 +288,7 @@ internal fun <T : PreferenceModel, V> PreferenceUiScope<T>.DialogSliderPreferenc
 fun <T : PreferenceModel> PreferenceUiScope<T>.DialogSliderPreference(
     pref: PreferenceData<Int>,
     modifier: Modifier = Modifier,
-    @DrawableRes iconId: Int? = null,
+    icon: JetIcon = EmptyIcon,
     iconSpaceReserved: Boolean = this.iconSpaceReserved,
     title: String,
     valueLabel: @Composable (Int) -> String = { it.toString() },
@@ -303,7 +302,7 @@ fun <T : PreferenceModel> PreferenceUiScope<T>.DialogSliderPreference(
     visibleIf: PreferenceDataEvaluator = { true },
 ) {
     DialogSliderPreference(
-        pref, modifier, iconId, iconSpaceReserved, title, valueLabel, summary, min, max,
+        pref, modifier, icon, iconSpaceReserved, title, valueLabel, summary, min, max,
         stepIncrement, onPreviewSelectedValue, dialogStrings, enabledIf, visibleIf,
     ) {
         try {
@@ -320,7 +319,7 @@ fun <T : PreferenceModel> PreferenceUiScope<T>.DialogSliderPreference(
  * @param primaryPref The primary integer preference data entry from the datastore.
  * @param secondaryPref The secondary integer preference data entry from the datastore.
  * @param modifier Modifier to be applied to the underlying list item.
- * @param iconId The icon ID of the list entry icon.
+ * @param icon The [JetIcon] of the list entry.
  * @param iconSpaceReserved If the space at the start of the list item should be reserved (blank
  *  space) if no icon ID is provided.
  * @param title The title of this preference, shown as the list item primary text (max 1 line).
@@ -353,7 +352,7 @@ fun <T : PreferenceModel> PreferenceUiScope<T>.DialogSliderPreference(
     primaryPref: PreferenceData<Int>,
     secondaryPref: PreferenceData<Int>,
     modifier: Modifier = Modifier,
-    @DrawableRes iconId: Int? = null,
+    icon: JetIcon = EmptyIcon,
     iconSpaceReserved: Boolean = this.iconSpaceReserved,
     title: String,
     primaryLabel: String,
@@ -370,9 +369,9 @@ fun <T : PreferenceModel> PreferenceUiScope<T>.DialogSliderPreference(
     visibleIf: PreferenceDataEvaluator = { true },
 ) {
     DialogSliderPreference(
-        primaryPref, secondaryPref, modifier, iconId, iconSpaceReserved, title,
-        primaryLabel, secondaryLabel, valueLabel, summary, min, max, stepIncrement,
-        onPreviewSelectedPrimaryValue, onPreviewSelectedSecondaryValue, dialogStrings, enabledIf, visibleIf,
+        primaryPref, secondaryPref, modifier, icon, iconSpaceReserved, title, primaryLabel,
+        secondaryLabel, valueLabel, summary, min, max, stepIncrement, onPreviewSelectedPrimaryValue,
+        onPreviewSelectedSecondaryValue, dialogStrings, enabledIf, visibleIf,
     ) {
         try {
             it.roundToInt()
@@ -387,7 +386,7 @@ fun <T : PreferenceModel> PreferenceUiScope<T>.DialogSliderPreference(
  *
  * @param pref The long preference data entry from the datastore.
  * @param modifier Modifier to be applied to the underlying list item.
- * @param iconId The icon ID of the list entry icon.
+ * @param icon The [JetIcon] of the list entry.
  * @param iconSpaceReserved If the space at the start of the list item should be reserved (blank
  *  space) if no icon ID is provided.
  * @param title The title of this preference, shown as the list item primary text (max 1 line).
@@ -414,7 +413,7 @@ fun <T : PreferenceModel> PreferenceUiScope<T>.DialogSliderPreference(
 fun <T : PreferenceModel> PreferenceUiScope<T>.DialogSliderPreference(
     pref: PreferenceData<Long>,
     modifier: Modifier = Modifier,
-    @DrawableRes iconId: Int? = null,
+    icon: JetIcon = EmptyIcon,
     iconSpaceReserved: Boolean = this.iconSpaceReserved,
     title: String,
     valueLabel: @Composable (Long) -> String = { it.toString() },
@@ -428,7 +427,7 @@ fun <T : PreferenceModel> PreferenceUiScope<T>.DialogSliderPreference(
     visibleIf: PreferenceDataEvaluator = { true },
 ) {
     DialogSliderPreference(
-        pref, modifier, iconId, iconSpaceReserved, title, valueLabel, summary, min, max,
+        pref, modifier, icon, iconSpaceReserved, title, valueLabel, summary, min, max,
         stepIncrement, onPreviewSelectedValue, dialogStrings, enabledIf, visibleIf,
     ) {
         try {
@@ -445,7 +444,7 @@ fun <T : PreferenceModel> PreferenceUiScope<T>.DialogSliderPreference(
  * @param primaryPref The primary long preference data entry from the datastore.
  * @param secondaryPref The secondary long preference data entry from the datastore.
  * @param modifier Modifier to be applied to the underlying list item.
- * @param iconId The icon ID of the list entry icon.
+ * @param icon The [JetIcon] of the list entry.
  * @param iconSpaceReserved If the space at the start of the list item should be reserved (blank
  *  space) if no icon ID is provided.
  * @param title The title of this preference, shown as the list item primary text (max 1 line).
@@ -478,7 +477,7 @@ fun <T : PreferenceModel> PreferenceUiScope<T>.DialogSliderPreference(
     primaryPref: PreferenceData<Long>,
     secondaryPref: PreferenceData<Long>,
     modifier: Modifier = Modifier,
-    @DrawableRes iconId: Int? = null,
+    icon: JetIcon = EmptyIcon,
     iconSpaceReserved: Boolean = this.iconSpaceReserved,
     title: String,
     primaryLabel: String,
@@ -495,9 +494,9 @@ fun <T : PreferenceModel> PreferenceUiScope<T>.DialogSliderPreference(
     visibleIf: PreferenceDataEvaluator = { true },
 ) {
     DialogSliderPreference(
-        primaryPref, secondaryPref, modifier, iconId, iconSpaceReserved, title,
-        primaryLabel, secondaryLabel, valueLabel, summary, min, max, stepIncrement,
-        onPreviewSelectedPrimaryValue, onPreviewSelectedSecondaryValue, dialogStrings, enabledIf, visibleIf,
+        primaryPref, secondaryPref, modifier, icon, iconSpaceReserved, title, primaryLabel,
+        secondaryLabel, valueLabel, summary, min, max, stepIncrement, onPreviewSelectedPrimaryValue,
+        onPreviewSelectedSecondaryValue, dialogStrings, enabledIf, visibleIf,
     ) {
         try {
             it.roundToLong()
@@ -512,7 +511,7 @@ fun <T : PreferenceModel> PreferenceUiScope<T>.DialogSliderPreference(
  *
  * @param pref The double preference data entry from the datastore.
  * @param modifier Modifier to be applied to the underlying list item.
- * @param iconId The icon ID of the list entry icon.
+ * @param icon The [JetIcon] of the list entry.
  * @param iconSpaceReserved If the space at the start of the list item should be reserved (blank
  *  space) if no icon ID is provided.
  * @param title The title of this preference, shown as the list item primary text (max 1 line).
@@ -539,7 +538,7 @@ fun <T : PreferenceModel> PreferenceUiScope<T>.DialogSliderPreference(
 fun <T : PreferenceModel> PreferenceUiScope<T>.DialogSliderPreference(
     pref: PreferenceData<Double>,
     modifier: Modifier = Modifier,
-    @DrawableRes iconId: Int? = null,
+    icon: JetIcon = EmptyIcon,
     iconSpaceReserved: Boolean = this.iconSpaceReserved,
     title: String,
     valueLabel: @Composable (Double) -> String = { it.toString() },
@@ -553,7 +552,7 @@ fun <T : PreferenceModel> PreferenceUiScope<T>.DialogSliderPreference(
     visibleIf: PreferenceDataEvaluator = { true },
 ) {
     DialogSliderPreference(
-        pref, modifier, iconId, iconSpaceReserved, title, valueLabel, summary, min, max,
+        pref, modifier, icon, iconSpaceReserved, title, valueLabel, summary, min, max,
         stepIncrement, onPreviewSelectedValue, dialogStrings, enabledIf, visibleIf,
     ) { it.toDouble() }
 }
@@ -564,7 +563,7 @@ fun <T : PreferenceModel> PreferenceUiScope<T>.DialogSliderPreference(
  * @param primaryPref The primary double preference data entry from the datastore.
  * @param secondaryPref The secondary double preference data entry from the datastore.
  * @param modifier Modifier to be applied to the underlying list item.
- * @param iconId The icon ID of the list entry icon.
+ * @param icon The [JetIcon] of the list entry.
  * @param iconSpaceReserved If the space at the start of the list item should be reserved (blank
  *  space) if no icon ID is provided.
  * @param title The title of this preference, shown as the list item primary text (max 1 line).
@@ -597,7 +596,7 @@ fun <T : PreferenceModel> PreferenceUiScope<T>.DialogSliderPreference(
     primaryPref: PreferenceData<Double>,
     secondaryPref: PreferenceData<Double>,
     modifier: Modifier = Modifier,
-    @DrawableRes iconId: Int? = null,
+    icon: JetIcon = EmptyIcon,
     iconSpaceReserved: Boolean = this.iconSpaceReserved,
     title: String,
     primaryLabel: String,
@@ -614,9 +613,9 @@ fun <T : PreferenceModel> PreferenceUiScope<T>.DialogSliderPreference(
     visibleIf: PreferenceDataEvaluator = { true },
 ) {
     DialogSliderPreference(
-        primaryPref, secondaryPref, modifier, iconId, iconSpaceReserved, title,
-        primaryLabel, secondaryLabel, valueLabel, summary, min, max, stepIncrement,
-        onPreviewSelectedPrimaryValue, onPreviewSelectedSecondaryValue, dialogStrings, enabledIf, visibleIf,
+        primaryPref, secondaryPref, modifier, icon, iconSpaceReserved, title, primaryLabel,
+        secondaryLabel, valueLabel, summary, min, max, stepIncrement, onPreviewSelectedPrimaryValue,
+        onPreviewSelectedSecondaryValue, dialogStrings, enabledIf, visibleIf,
     ) { it.toDouble() }
 }
 
@@ -625,7 +624,7 @@ fun <T : PreferenceModel> PreferenceUiScope<T>.DialogSliderPreference(
  *
  * @param pref The float preference data entry from the datastore.
  * @param modifier Modifier to be applied to the underlying list item.
- * @param iconId The icon ID of the list entry icon.
+ * @param icon The [JetIcon] of the list entry.
  * @param iconSpaceReserved If the space at the start of the list item should be reserved (blank
  *  space) if no icon ID is provided.
  * @param title The title of this preference, shown as the list item primary text (max 1 line).
@@ -652,7 +651,7 @@ fun <T : PreferenceModel> PreferenceUiScope<T>.DialogSliderPreference(
 fun <T : PreferenceModel> PreferenceUiScope<T>.DialogSliderPreference(
     pref: PreferenceData<Float>,
     modifier: Modifier = Modifier,
-    @DrawableRes iconId: Int? = null,
+    icon: JetIcon = EmptyIcon,
     iconSpaceReserved: Boolean = this.iconSpaceReserved,
     title: String,
     valueLabel: @Composable (Float) -> String = { it.toString() },
@@ -666,7 +665,7 @@ fun <T : PreferenceModel> PreferenceUiScope<T>.DialogSliderPreference(
     visibleIf: PreferenceDataEvaluator = { true },
 ) {
     DialogSliderPreference(
-        pref, modifier, iconId, iconSpaceReserved, title, valueLabel, summary, min, max,
+        pref, modifier, icon, iconSpaceReserved, title, valueLabel, summary, min, max,
         stepIncrement, onPreviewSelectedValue, dialogStrings, enabledIf, visibleIf,
     ) { it }
 }
@@ -677,7 +676,7 @@ fun <T : PreferenceModel> PreferenceUiScope<T>.DialogSliderPreference(
  * @param primaryPref The primary float preference data entry from the datastore.
  * @param secondaryPref The secondary float preference data entry from the datastore.
  * @param modifier Modifier to be applied to the underlying list item.
- * @param iconId The icon ID of the list entry icon.
+ * @param icon The [JetIcon] of the list entry.
  * @param iconSpaceReserved If the space at the start of the list item should be reserved (blank
  *  space) if no icon ID is provided.
  * @param title The title of this preference, shown as the list item primary text (max 1 line).
@@ -710,7 +709,7 @@ fun <T : PreferenceModel> PreferenceUiScope<T>.DialogSliderPreference(
     primaryPref: PreferenceData<Float>,
     secondaryPref: PreferenceData<Float>,
     modifier: Modifier = Modifier,
-    @DrawableRes iconId: Int? = null,
+    icon: JetIcon = EmptyIcon,
     iconSpaceReserved: Boolean = this.iconSpaceReserved,
     title: String,
     primaryLabel: String,
@@ -727,8 +726,8 @@ fun <T : PreferenceModel> PreferenceUiScope<T>.DialogSliderPreference(
     visibleIf: PreferenceDataEvaluator = { true },
 ) {
     DialogSliderPreference(
-        primaryPref, secondaryPref, modifier, iconId, iconSpaceReserved, title,
-        primaryLabel, secondaryLabel, valueLabel, summary, min, max, stepIncrement,
-        onPreviewSelectedPrimaryValue, onPreviewSelectedSecondaryValue, dialogStrings, enabledIf, visibleIf,
+        primaryPref, secondaryPref, modifier, icon, iconSpaceReserved, title, primaryLabel,
+        secondaryLabel, valueLabel, summary, min, max, stepIncrement, onPreviewSelectedPrimaryValue,
+        onPreviewSelectedSecondaryValue, dialogStrings, enabledIf, visibleIf,
     ) { it }
 }

datastore-ui/src/main/kotlin/dev/patrickgold/jetpref/datastore/ui/JetIcon.kt

@@ -0,0 +1,65 @@
+package dev.patrickgold.jetpref.datastore.ui
+
+import androidx.annotation.DrawableRes
+import androidx.compose.runtime.Composable
+import androidx.compose.ui.graphics.vector.ImageVector
+
+/**
+ * Interface which provides the Icon for the JetPref library
+ *
+ * @since 0.1.0
+ */
+interface JetIcon {
+    /**
+     * Provie the Icon.
+     *
+     * @param iconSpaceReserved If the space at the start of the preference should be reserved,
+     *  if no icon is provided.
+     *
+     * @since 0.1.0
+     */
+    @Composable
+    fun getIcon(iconSpaceReserved: Boolean): @Composable (() -> Unit)?
+}
+
+class ImageVectorIcon(private val imageVector: ImageVector?) : JetIcon {
+    @Composable
+    override fun getIcon(iconSpaceReserved: Boolean): @Composable (() -> Unit)? {
+        return maybeJetIcon(imageVector = imageVector, iconSpaceReserved = iconSpaceReserved)
+    }
+}
+
+object EmptyIcon : JetIcon {
+    @Composable
+    override fun getIcon(iconSpaceReserved: Boolean): @Composable (() -> Unit)? {
+        return if (iconSpaceReserved) {
+            ({ })
+        } else {
+            null
+        }
+    }
+}
+
+class DrawableResIcon(@DrawableRes private val iconId: Int?) : JetIcon {
+    @Composable
+    override fun getIcon(iconSpaceReserved: Boolean): @Composable (() -> Unit)? {
+        return maybeJetIcon(id = iconId, iconSpaceReserved = iconSpaceReserved)
+    }
+}
+
+
+/**
+ * Get the JetIcon from the [ImageVector] or the [EmptyIcon] if null
+ *
+ * @since 0.1.0
+ */
+val ImageVector?.jetIcon: JetIcon
+    get() = if (this == null) { EmptyIcon } else { ImageVectorIcon(this) }
+
+/**
+ * Get the JetIcon from the [DrawableRes] ID or the [EmptyIcon] if null
+ *
+ * @since 0.1.0
+ */
+val @receiver:DrawableRes Int?.jetIcon: JetIcon
+    get() = if (this == null) { EmptyIcon } else { DrawableResIcon(this) }

datastore-ui/src/main/kotlin/dev/patrickgold/jetpref/datastore/ui/ListPreference.kt

@@ -17,7 +17,6 @@
 package dev.patrickgold.jetpref.datastore.ui
 
 import android.annotation.SuppressLint
-import androidx.annotation.DrawableRes
 import androidx.compose.foundation.clickable
 import androidx.compose.foundation.layout.Box
 import androidx.compose.foundation.layout.Column
@@ -198,7 +197,7 @@ fun <T : PreferenceModel, V : Any> PreferenceUiScope<T>.ListPreference(
     listPref: PreferenceData<V>,
     switchPref: PreferenceData<Boolean>? = null,
     modifier: Modifier = Modifier,
-    @DrawableRes iconId: Int? = null,
+    icon: JetIcon = EmptyIcon,
     iconSpaceReserved: Boolean = this.iconSpaceReserved,
     title: String,
     summarySwitchDisabled: String? = null,
@@ -229,7 +228,7 @@ fun <T : PreferenceModel, V : Any> PreferenceUiScope<T>.ListPreference(
                         isDialogOpen.value = true
                     }
                 ),
-            icon = maybeJetIcon(iconId, iconSpaceReserved),
+            icon = icon.getIcon(iconSpaceReserved),
             text = title,
             secondaryText = if (switchPrefValue?.value == true || switchPrefValue == null) {
                 entries.find {