Merge pull request #1 from KvColorPallet/feature/introduce-new-colors-to-theme-pallet

kavi707 · web-flow · commit 182bcdfb1763 · 2025-01-07T22:18:07.000-05:00
Feature/introduce new colors to theme pallet
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# KV Android Color Pallet
+# KV Color Pallet - Android
 
 This is a lightweight Android library that generates a color palette from a given color and creates a theme color set for Android applications. 
 This library simplifies the process of building consistent and visually appealing color themes.
@@ -24,29 +24,55 @@ Add the following dependency to your `build.gradle` / `build.gradle.kts` file:
 For Groovy - `build.gradle`:
 ````
 dependencies {
-    implementation 'com.github.kavi707:kv-android-color-pallet:0.0.2'
+    implementation 'com.github.kavi707:kv-android-color-pallet:0.0.3'
 }
 ````
 For Kotlin DSL - `build.gradle.kts`:
 ````
 dependencies {
-    implementation("com.github.kavi707:kv-android-color-pallet:0.0.2")
+    implementation("com.github.kavi707:kv-android-color-pallet:0.0.3")
 }
 ````
 
 # Usage
-### Initiate 
-On usage of the kv-android-color-pallet, from your application class, Initiate it using following code.
-While initiating, you have to parse a color (androidx.compose.ui.graphics.Color) that you prefer to use as your primary color in your application.
+After you integrated the `KvColorPallet-Android` library, you can consume it as follows.
+
+### Basic Usage
+If you wants to consume basic features in `KvColorPallet` then use singleton instance as follows. This singleton instance allows consumers to access following basic functionalities.
+```
+// Generate alpha color schem of given color
+KvColorPallet.instance.generateAlphaColorPallet(givenColor: MatPackage().matGold.color)
+
+// Generate mat color schem of given color
+KvColorPallet.instance.generateColorPallet(givenColor: MatPackage().matGold)
+
+// Generate theme color pallet of given color
+KvColorPallet.instance.generateThemeColorPallet(givenColor: MatPackage().matGold.color)
+```
+
+### Advance Usage
+If you wants to use `KvColorPallet-Android` to generate your theme color pallet when your application start-up, then you have to initiate the library in Application level.
+To initiate you have to pass one base color that you think your application will use. Use following code to initiate the library package.
 ````
 override fun onCreate() {
     super.onCreate()
     // Initialize the kv-android-color-pallet
-    KvColorPallet.init(MatPackage.MatDGreen.color)
+    KvColorPallet.initialize(MatPackage.MatDGreen)
 }
 ````
-This initiation create a color set for a theme using the given color at the initiation. 
-This generated color set available for light and dark theme variants.
+This initiation create a color set for a theme using the given color at the initiation. This generated color set available for light and dark theme variants.
+
+In this `KvColorPallet.appThemePallet` you will have following color attributes.
+|Attribute    |light-theme |dark-theme  |Description   |
+|-------------|------------|------------|--------------|
+|.base        |original    |original    |This is the base color given by the user.   |
+|.primary     |available   |available   |Suggesting primary color. This color can use for buttons, major component etc.   |
+|.secondary   |available   |available   |Suggesting secondary color. For any the secondary components which should not use by primary color.   |
+|.tertiary    |available   |available   |Suggesting tertiary color.   |
+|.background  |available   |available   |Suggesting background color.   |
+|.onPrimary   |available   |available   |This is the color you can use on any component use primary color.   |
+|.onSecondary |available   |available   |This is the color you can use on any component use secondary color.   |
+|.shadow      |available   |available   |This is the color for your shadows.   |
 
 ### Use generated theme
 As mentioned above, according to the initiation color, that generate the color set for light and dark them.
diff --git a/kv-color-pallet/src/main/kotlin/com/kavi/droid/color/pallet/KvColorPallet.kt b/kv-color-pallet/src/main/kotlin/com/kavi/droid/color/pallet/KvColorPallet.kt
@@ -17,28 +17,34 @@ import com.kavi.droid.color.pallet.util.ThemeGenUtil
 /**
  * This is the kv-color-pallet android library.
  */
-class KvColorPallet(private val givenColor: Color = Color.White) {
+class KvColorPallet {
 
     companion object {
-        var instance: KvColorPallet? = null
+        /**
+         * This is a basic initialization without a basic color.  When consumer use this initialization, in default KvColorPallet with not
+         * provide a theme color pallet. Consumer can use this as a singleton.
+         */
+        var instance: KvColorPallet = KvColorPallet()
         lateinit var appThemePallet: AppThemePallet
 
-        fun init(givenColor: Color) {
-            instance ?: run {
-                instance = KvColorPallet(givenColor = givenColor)
-            }
+        /**
+         * KvColorPallet initialization. Consumer can use this to initialize the KvColorPallet from their application delegate if they need a
+         * Theme color pallet at the application start-up.
+         *
+         * On this initiation of kv-color-pallet, we generate a theme color pallet using the given color.
+         * `basicColor` is mandatory parameter while initiate the library.
+         */
+        fun initialize(basicColor: KvColor) {
+            val closestColor = ColorUtil.findClosestColor(basicColor.color)
+            appThemePallet = instance.generateThemeColorPallet(closestColor.color)
         }
     }
 
     init {
         /**
-         * On initiation of kv-color-pallet, we generate a theme color pallet using the given color.
-         * `givenColor` is mandatory parameter while initiate the library.
-         *
-         * Consumer who is using kv-color-pallet, will get a color pallet for the theme of the application
+         * This generate theme-pallet with color transparent. This is un-usable.
          */
-        val closestColor = ColorUtil.findClosestColor(givenColor)
-        appThemePallet = generateThemeColorPallet(closestColor)
+        appThemePallet = generateThemeColorPallet(Color.Transparent)
     }
 
     /**
@@ -90,7 +96,7 @@ class KvColorPallet(private val givenColor: Color = Color.White) {
      * @param givenColor The color to generate the theme color pallet for.
      * @return A theme color pallet.
      */
-    fun generateThemeColorPallet(givenColor: KvColor): AppThemePallet {
+    fun generateThemeColorPallet(givenColor: Color): AppThemePallet {
         return ThemeGenUtil.generateThemeColorSet(givenColor = givenColor)
     }
 }
diff --git a/kv-color-pallet/src/main/kotlin/com/kavi/droid/color/pallet/model/ThemeColorPallet.kt b/kv-color-pallet/src/main/kotlin/com/kavi/droid/color/pallet/model/ThemeColorPallet.kt
@@ -14,10 +14,12 @@ data class AppThemePallet(
  * Color pallet for theme.
  */
 data class ThemeColorPallet(
+    val base: Color,
     val primary: Color,
     val secondary: Color,
     val tertiary: Color,
     val background: Color = Color.White,
     val onPrimary: Color = Color.White,
     val onSecondary: Color = Color.White,
+    val shadow: Color = Color.Gray
 )
diff --git a/kv-color-pallet/src/main/kotlin/com/kavi/droid/color/pallet/util/ColorUtil.kt b/kv-color-pallet/src/main/kotlin/com/kavi/droid/color/pallet/util/ColorUtil.kt
@@ -76,7 +76,7 @@ object ColorUtil {
                             shortestDistance = colorMatch300.colorDistance
                             closestColor = colorMatch300.matchedColor
 
-                            // Do comparison with 300 color list
+                            // Do comparison with 200 color list
                             val colorMatch200 = Mat200Package.compareColor(givenColor)
 
                             if (colorMatch200.isExactMatch) {
diff --git a/kv-color-pallet/src/main/kotlin/com/kavi/droid/color/pallet/util/ThemeGenUtil.kt b/kv-color-pallet/src/main/kotlin/com/kavi/droid/color/pallet/util/ThemeGenUtil.kt
@@ -14,11 +14,11 @@ object ThemeGenUtil {
      * @param givenColor The color to generate theme color set.
      * @return A theme color set. [AppThemePallet]
      */
-    internal fun generateThemeColorSet(givenColor: KvColor): AppThemePallet {
-        val closestColor = findClosestColor(givenColor.color)
+    internal fun generateThemeColorSet(givenColor: Color): AppThemePallet {
+        val closestColor = findClosestColor(givenColor)
 
-        val lightColorPallet = generateLightThemeColorSet(closestColor)
-        val darkColorPallet = generateDarkThemeColorSet(closestColor)
+        val lightColorPallet = generateLightThemeColorSet(givenColor, closestColor)
+        val darkColorPallet = generateDarkThemeColorSet(givenColor, closestColor)
 
         return AppThemePallet(light = lightColorPallet, dark = darkColorPallet)
     }
@@ -28,14 +28,16 @@ object ThemeGenUtil {
      * @param closestColor The closest color to original consumer given color.
      * @return A light theme color set. [ThemeColorPallet]
      */
-    private fun generateLightThemeColorSet(closestColor: KvColor): ThemeColorPallet {
+    private fun generateLightThemeColorSet(givenColor: Color, closestColor: KvColor): ThemeColorPallet {
         return ThemeColorPallet(
+            base = givenColor,
             primary = closestColor.color,
             secondary = generateLightSecondaryColor(closestColor.color),
             tertiary = generateLightTeriaryColor(closestColor),
             background = generateLightBackgroundColor(closestColor),
             onPrimary = Color.White,
-            onSecondary = Color.White
+            onSecondary = Color.White,
+            shadow = Color.Gray
         )
     }
 
@@ -44,16 +46,18 @@ object ThemeGenUtil {
      * @param closestColor The closest color to original consumer given color.
      * @return A dark theme color set. [ThemeColorPallet]
      */
-    private fun generateDarkThemeColorSet(primaryColor: KvColor): ThemeColorPallet {
+    private fun generateDarkThemeColorSet(givenColor: Color, primaryColor: KvColor): ThemeColorPallet {
         val closestColor = findClosestColor(primaryColor.color)
 
         return ThemeColorPallet(
+            base = givenColor,
             primary = generateDarkPrimaryColor(closestColor.color),
             secondary = generateDarkSecondaryColor(closestColor.color),
             tertiary = generateDarkTeriaryColor(closestColor),
             background = generateDarkBackgroundColor(closestColor.color),
             onPrimary = Color.White,
-            onSecondary = Color.Black
+            onSecondary = Color.Black,
+            shadow = Color.White
         )
     }
 
diff --git a/ui-app/src/main/kotlin/com/kavi/droid/color/pallet/app/KvColorPalletApp.kt b/ui-app/src/main/kotlin/com/kavi/droid/color/pallet/app/KvColorPalletApp.kt
@@ -9,6 +9,6 @@ class KvColorPalletApp: Application() {
     override fun onCreate() {
         super.onCreate()
         // Initialize the kv color pallet
-        KvColorPallet.init(MatPackage.MatDGreen.color)
+        KvColorPallet.initialize(MatPackage.MatDGreen)
     }
 }
diff --git a/ui-app/src/main/kotlin/com/kavi/droid/color/pallet/app/theme/Theme.kt b/ui-app/src/main/kotlin/com/kavi/droid/color/pallet/app/theme/Theme.kt
@@ -9,21 +9,6 @@ import androidx.compose.runtime.Composable
 import androidx.compose.ui.graphics.Color
 import com.kavi.droid.color.pallet.KvColorPallet
 
-/*private val LightColorScheme = lightColorScheme(
-    primary = Purple40,
-    secondary = PurpleGrey40,
-    tertiary = Pink40,
-    background = Color.Gray
-    /* Other default colors to override */
-    background = Color(0xFFFFFBFE),
-    surface = Color(0xFFFFFBFE),
-    onPrimary = Color.White,
-    onSecondary = Color.White,
-    onTertiary = Color.White,
-    onBackground = Color(0xFF1C1B1F),
-    onSurface = Color(0xFF1C1B1F),
-)*/
-
 @Composable
 fun KvColorPalletTheme(
     darkTheme: Boolean = isSystemInDarkTheme(),
diff --git a/ui-app/src/main/kotlin/com/kavi/droid/color/pallet/app/ui/MainActivity.kt b/ui-app/src/main/kotlin/com/kavi/droid/color/pallet/app/ui/MainActivity.kt
@@ -49,7 +49,7 @@ fun TabViewExample() {
             name = "Color Pallet",
             icon = R.drawable.icon_color_grid
         ),
-        TabItem(name = "Theme Gen", icon = R.drawable.icon_theme_set)
+        TabItem(name = "Theme Gen", icon = R.drawable.icon_theme_masks)
     )
     var selectedTabIndex by remember { mutableStateOf(0) }
 
diff --git a/ui-app/src/main/kotlin/com/kavi/droid/color/pallet/app/ui/tab/pallet/pager/AlphaPalletPager.kt b/ui-app/src/main/kotlin/com/kavi/droid/color/pallet/app/ui/tab/pallet/pager/AlphaPalletPager.kt
@@ -67,7 +67,7 @@ fun AlphaPalletPager() {
 
 @Composable
 fun AlphaPalletColorRow(givenColor: KvColor, selectedColor: Color, onSelect: (color: Color) -> Unit) {
-    val colors = KvColorPallet.instance!!.generateAlphaColorPallet(givenColor.color)
+    val colors = KvColorPallet.instance.generateAlphaColorPallet(givenColor.color)
     Row {
         colors.forEach {
             ColorBox(givenColor = it, selectedColor = selectedColor, onSelect = onSelect)
diff --git a/ui-app/src/main/kotlin/com/kavi/droid/color/pallet/app/ui/tab/pallet/pager/PalletPager.kt b/ui-app/src/main/kotlin/com/kavi/droid/color/pallet/app/ui/tab/pallet/pager/PalletPager.kt
@@ -66,7 +66,7 @@ fun PalletPager() {
 
 @Composable
 fun PalletColorRow(givenColor: KvColor, selectedColor: Color, onSelect: (color: Color) -> Unit) {
-    val colors = KvColorPallet(givenColor.color).generateColorPallet(givenColor)
+    val colors = KvColorPallet.instance.generateColorPallet(givenColor)
     Row {
         colors.forEach {
             ColorBox(givenColor = it, selectedColor = selectedColor, onSelect = onSelect)
diff --git a/ui-app/src/main/kotlin/com/kavi/droid/color/pallet/app/ui/tab/theme/ThemeColorGen.kt b/ui-app/src/main/kotlin/com/kavi/droid/color/pallet/app/ui/tab/theme/ThemeColorGen.kt
@@ -108,8 +108,8 @@ fun ThemeColorRow(givenColor: KvColor) {
                 .fillMaxWidth(),
                 verticalArrangement = Arrangement.Center,
             ) {
-                val appThemeColorSet = KvColorPallet().generateThemeColorPallet(
-                    givenColor = givenColor,
+                val appThemeColorSet = KvColorPallet.instance.generateThemeColorPallet(
+                    givenColor = givenColor.color,
                 )
 
                 Text("Light Theme", Modifier.padding(top = 8.dp, start = 8.dp), style = MaterialTheme.typography.bodyMedium, fontWeight = FontWeight.ExtraBold,)
diff --git a/ui-app/src/main/res/drawable/icon_theme_masks.xml b/ui-app/src/main/res/drawable/icon_theme_masks.xml
@@ -0,0 +1,18 @@
+<vector xmlns:android="http://schemas.android.com/apk/res/android"
+    android:width="64dp"
+    android:height="64dp"
+    android:viewportWidth="64"
+    android:viewportHeight="64">
+  <path
+      android:fillColor="#FF000000"
+      android:pathData="M63.606,11.913c-0.14,-0.52 -0.49,-0.93 -0.97,-1.15c-0.48,-0.21 -1.03,-0.19 -1.51,0.06c-5.915,3.15 -12.408,4.899 -19.05,4.61c-0.06,-0.71 -0.17,-1.35 -0.32,-1.91c-0.271,-1.061 -1.457,-1.618 -2.47,-1.09c-1.46,0.78 -2.93,1.46 -4.4,2.03c-3.38,-0.78 -6.81,-2.02 -10.28,-3.71c-0.947,-0.443 -2.095,0.026 -2.4,1.07c-0.37,1.31 -0.45,3.11 -0.28,5.24c-6.17,0.08 -12.61,-1.5 -19.17,-4.69c-0.46,-0.23 -1,-0.23 -1.46,-0.02c-0.46,0.21 -0.8,0.61 -0.93,1.08c-1.74,6.21 2.94,23.79 10.12,33.25c3.39,4.47 6.94,6.73 10.63,6.73c0.01,0 0.01,0 0.01,0c4.09,-0.3 8.08,-3.01 11.58,-7.88c3.26,4.16 6.7,6.27 10.26,6.27c4.41,-0.32 8.69,-3.45 12.38,-9.04C61.321,33.752 65.299,18.286 63.606,11.913zM47.006,39.853c-2,-2 -5.13,-2.26 -7.43,-0.62l-1.16,-1.63c3.1,-2.21 7.31,-1.86 10,0.84L47.006,39.853zM47.276,27.003l-1.41,-1.41c2.77,-2.78 7.28,-2.78 10.06,0l-1.42,1.41C52.516,25.013 49.276,25.013 47.276,27.003zM21.056,51.413c-3.69,0 -6.92,-3.23 -8.98,-5.94c-7.08,-9.34 -11.05,-25.66 -9.87,-31.15c6.8,3.26 13.5,4.85 19.94,4.74c5.847,0 12.484,-1.891 17.76,-4.69c1.347,6.286 -2.951,21.984 -8.46,29.46C29.106,47.243 25.496,51.093 21.056,51.413z"/>
+  <path
+      android:fillColor="#FF000000"
+      android:pathData="M18.084,27.218c-1.34,-1.339 -3.125,-2.081 -5.036,-2.089c-1.902,0.008 -3.688,0.75 -5.027,2.089l1.414,1.414c0.964,-0.963 2.25,-1.497 3.613,-1.503c1.371,0.005 2.657,0.54 3.621,1.503L18.084,27.218z"/>
+  <path
+      android:fillColor="#FF000000"
+      android:pathData="M34.079,27.218c-2.774,-2.774 -7.288,-2.774 -10.063,0l1.414,1.414c1.995,-1.994 5.239,-1.994 7.234,0L34.079,27.218z"/>
+  <path
+      android:fillColor="#FF000000"
+      android:pathData="M20.254,41.759c-1.499,-0.138 -2.97,-1.355 -4.373,-3.62l-1.7,1.054c1.776,2.866 3.702,4.356 5.89,4.558c0.166,0.015 0.331,0.022 0.498,0.022c2.248,0 4.607,-1.389 7.191,-4.231l-1.479,-1.346C23.989,40.716 21.965,41.914 20.254,41.759z"/>
+</vector>

Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,6 @@ class KvColorPalletApp: Application() {`
`9`	`9`	`override fun onCreate() {`
`10`	`10`	`super.onCreate()`
`11`	`11`	`// Initialize the kv color pallet`
`12`		`- KvColorPallet.init(MatPackage.MatDGreen.color)`
	`12`	`+ KvColorPallet.initialize(MatPackage.MatDGreen)`
`13`	`13`	`}`
`14`	`14`	`}`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ fun TabViewExample() {`
`49`	`49`	`name = "Color Pallet",`
`50`	`50`	`icon = R.drawable.icon_color_grid`
`51`	`51`	`),`
`52`		`- TabItem(name = "Theme Gen", icon = R.drawable.icon_theme_set)`
	`52`	`+ TabItem(name = "Theme Gen", icon = R.drawable.icon_theme_masks)`
`53`	`53`	`)`
`54`	`54`	`var selectedTabIndex by remember { mutableStateOf(0) }`
`55`	`55`