Merge pull request #16 from KvColorPalette/feature/theme-palette-extension

Feature/theme palette extension

Author: kavi707

README.md

@@ -7,7 +7,7 @@ This library simplifies the process of building consistent and visually appealin
 
 # Features
 * Generate a color palette based on a single input color. Using color alpha/mat-colors
-* Create a complete theme color set, including primary, secondary, background, and surface colors.
+* Create a complete theme color schemas, including primary, secondary, background, and surface colors.
 * Support for Material Design color guidelines.
 * Easy integration with Android projects.
 
@@ -26,13 +26,13 @@ Add the following dependency to your `build.gradle` / `build.gradle.kts` file:
 For Groovy - `build.gradle`:
 ````
 dependencies {
-    implementation 'com.github.KvColorPalette:KvColorPalette-Android:1.2.1'
+    implementation 'com.github.KvColorPalette:KvColorPalette-Android:2.0.0'
 }
 ````
 For Kotlin DSL - `build.gradle.kts`:
 ````
 dependencies {
-    implementation("com.github.KvColorPalette:KvColorPalette-Android:1.2.1")
+    implementation("com.github.KvColorPalette:KvColorPalette-Android:2.0.0")
 }
 ````
 
@@ -68,9 +68,9 @@ override fun onCreate() {
     KvColorPalette.initialize(Color.blue)
 }
 ````
-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 schemas for a theme using the given color at the initiation. This generated color schemas will available for light and dark theme variants.
 
-In this `KvColorPalette.appThemePalette` you will have following color attributes.
+In this `KvColorPalette.colorSchemeThemePalette` you will have following color attributes.
 |Attribute    |light-theme |dark-theme  |Description   |
 |-------------|------------|------------|--------------|
 |.base        |original    |original    |This is the base color given by the user.   |
@@ -83,37 +83,17 @@ In this `KvColorPalette.appThemePalette` you will have following color attribute
 |.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.   |
 
+This `ColorSchemaThemePalette` is another Android Jetpack Compose `ColorSchema`. But that contains additional attributes like `base`, `quaternary`, `shadow` that provide 
+by the `KvColorPalette-Android` library. All above table mentioned colors are generated according to the given color and created the `ColorScheme`.
+
 ### Use generated theme
 As mentioned above, according to the initiation color, that generate the color set for light and dark them.
-In your Jetpack Compose project, you can assign generate color set the your application theme.
+In your Jetpack Compose project, you can assign generate color schemas to your application theme.
 ````
-    // Access the generated theme color set from KvColorPalette-Android library
-    val theme = KvColorPalette.appThemePalette
-
-    // Generate application light theme using KvColorPalette-Android light colors
-    val themeLight = lightColorScheme(
-        primary = theme.light.primary,
-        secondary = theme.light.secondary,
-        tertiary = theme.light.tertiary,
-        background = theme.light.background,
-        onPrimary = theme.light.onPrimary,
-        onSecondary = theme.light.onSecondary
-    )
-
-    // Generate application dark theme using KvColorPalette-Android dark colors
-    val themeDark = darkColorScheme(
-        primary = theme.dark.primary,
-        secondary = theme.dark.secondary,
-        tertiary = theme.dark.tertiary,
-        background = theme.dark.background,
-        onPrimary = theme.dark.onPrimary,
-        onSecondary = theme.dark.onSecondary
-    )
-    
     // Generate the color schema
     val appColorScheme = when {
-        darkTheme -> themeDark
-        else -> themeLight
+        darkTheme -> KvColorPalette.colorSchemeThemePalette.darkColorScheme
+        else -> KvColorPalette.colorSchemeThemePalette.lightColorScheme
     }
 
     // Assign the color schema to the team.

kv-color-palette/gradle.properties

@@ -1,3 +1,3 @@
 kvColorPaletteGroupId=com.github.KvColorPalette
 kvColorPaletteArtifactId=KvColorPalette-Android
-kvColorPaletteVersion=1.2.1
+kvColorPaletteVersion=2.0.0

kv-color-palette/src/main/kotlin/com/kavi/droid/color/palette/KvColorPalette.kt

@@ -13,6 +13,7 @@ import com.kavi.droid.color.palette.color.Mat900Package
 import com.kavi.droid.color.palette.color.MatPackage
 import com.kavi.droid.color.palette.extension.hsl
 import com.kavi.droid.color.palette.model.AppThemePalette
+import com.kavi.droid.color.palette.model.ColorSchemeThemePalette
 import com.kavi.droid.color.palette.model.KvColor
 import com.kavi.droid.color.palette.util.ColorUtil
 import com.kavi.droid.color.palette.util.ThemeGenUtil
@@ -28,18 +29,23 @@ class KvColorPalette {
          * provide a theme color palette. Consumer can use this as a singleton.
          */
         var instance: KvColorPalette = KvColorPalette()
+        @Deprecated("This field is deprecated. This is replaced by colorSchemeThemePalette")
         lateinit var appThemePalette: AppThemePalette
+        lateinit var colorSchemeThemePalette: ColorSchemeThemePalette
 
         /**
          * KvColorPalette initialization. Consumer can use this to initialize the KvColorPalette from their application, if they need a
          * Theme color palette at the application start-up.
          *
          * On this initiation of KvColorPalette, we generate a theme color palette using the given color.
          * `basicColor` is mandatory parameter while initiate the library.
+         *
+         * @param basicColor: Color: Given color for generate theme palette.
          */
         fun initialize(basicColor: Color) {
-            val closestColor = ColorUtil.findClosestColor(basicColor)
-            appThemePalette = instance.generateThemeColorPalette(closestColor.color)
+            val closestColor = ColorUtil.findClosestColor(givenColor = basicColor)
+            appThemePalette = instance.generateThemeColorPalette(givenColor = closestColor.color)
+            colorSchemeThemePalette = instance.generateThemeColorSchemePalette(givenColor = closestColor.color)
         }
     }
 
@@ -48,6 +54,11 @@ class KvColorPalette {
          * This generate theme-palette with color transparent. This is un-usable.
          */
         appThemePalette = generateThemeColorPalette(Color.Transparent)
+
+        /**
+         * This generate theme-palette with color transparent. This is un-usable.
+         */
+        colorSchemeThemePalette = generateThemeColorSchemePalette(Color.Transparent)
     }
 
     /**
@@ -149,8 +160,20 @@ class KvColorPalette {
      * @param givenColor The color to generate the theme color palette for.
      * @return A theme color palette.
      */
+    @Deprecated("This method is deprecated and replaced by generateThemeColorSchemePalette method", replaceWith = ReplaceWith(
+        "KvColorPalette.instance.generateThemeColorSchemePalette(givenColor = givenColor)"
+    ))
     fun generateThemeColorPalette(givenColor: Color): AppThemePalette = ThemeGenUtil.generateThemeColorSet(givenColor = givenColor)
 
+    /**
+     * Generate a theme color palette. According to the feeding color,
+     * this method generate a color scheme theme color palette.
+     *
+     * @param givenColor The color to generate the theme color palette for.
+     * @return A color scheme theme palette. [ColorSchemeThemePalette]
+     */
+    fun generateThemeColorSchemePalette(givenColor: Color): ColorSchemeThemePalette = ThemeGenUtil.generateThemeColorScheme(givenColor = givenColor)
+
     /**
      * This method finds the closest KvColor available in the KvColorPalette-Android to the given color
      *

kv-color-palette/src/main/kotlin/com/kavi/droid/color/palette/extension/Extension.kt

@@ -3,6 +3,7 @@ package com.kavi.droid.color.palette.extension
 import androidx.compose.ui.graphics.Color
 import androidx.compose.ui.graphics.toArgb
 import androidx.core.graphics.ColorUtils
+import com.kavi.droid.color.palette.model.HSL
 
 /**
  * Extension function to get HSL properties of a [Color]
@@ -12,15 +13,6 @@ import androidx.core.graphics.ColorUtils
 internal val Color.hsl: HSL
     get() = getHslProperties(this)
 
-/**
- * Data class to hold the hue, saturation and lightness properties of a [Color]
- */
-data class HSL(
-    val hue: Float,
-    val saturation: Float,
-    val lightness: Float
-)
-
 /**
  * This method extract and returns the hue, saturation and lightness properties of a [Color]
  *

kv-color-palette/src/main/kotlin/com/kavi/droid/color/palette/extension/OpenExtension.kt

@@ -1,9 +1,26 @@
 package com.kavi.droid.color.palette.extension
 
+import androidx.compose.material3.ColorScheme
 import androidx.compose.ui.graphics.Color
 
 /**
  * Extension property to check if a [Color] is a high-light color.
  */
 val Color.isHighLightColor: Boolean
-    get() = this.hsl.lightness > 0.6f
+    get() = this.hsl.lightness > 0.6f
+
+/**
+ * Providing new extension fields to [ColorScheme]
+ * @see base: Base color is the consumer provided color to generate the theme
+ * @see quaternary: Quaternary color is for the use of using primary color in light mode with contrast color in dark mode
+ * @see shadow: Shadow color is for the use of shadow in light mode and dark mode.
+ */
+var ColorScheme.base: Color
+    get() = Color.White
+    set(value) {}
+var ColorScheme.quaternary: Color
+    get() = Color.White
+    set(value) {}
+var ColorScheme.shadow: Color
+    get() = Color.White
+    set(value) {}

kv-color-palette/src/main/kotlin/com/kavi/droid/color/palette/model/HSL.kt

@@ -0,0 +1,12 @@
+package com.kavi.droid.color.palette.model
+
+import androidx.compose.ui.graphics.Color
+
+/**
+ * Data class to hold the hue, saturation and lightness properties of a [Color]
+ */
+data class HSL(
+    val hue: Float,
+    val saturation: Float,
+    val lightness: Float
+)

kv-color-palette/src/main/kotlin/com/kavi/droid/color/palette/model/ThemeColorPalette.kt

@@ -1,15 +1,27 @@
 package com.kavi.droid.color.palette.model
 
+import androidx.compose.material3.ColorScheme
 import androidx.compose.ui.graphics.Color
 
 /**
  * Application theme palette for light and dark mode.
  */
+@Deprecated(message = "This model is deprecated",
+    ReplaceWith("ColorSchemeThemePalette(lightColorScheme = lightScheme, darkColorScheme = darkScheme)")
+)
 data class AppThemePalette(
     val light: ThemeColorPalette,
     val dark: ThemeColorPalette
 )
 
+/**
+ * Application [ColorScheme] theme palette for light and dark mode.
+ */
+data class ColorSchemeThemePalette(
+    val lightColorScheme: ColorScheme,
+    val darkColorScheme: ColorScheme
+)
+
 /**
  * Color palette for theme.
  */

kv-color-palette/src/main/kotlin/com/kavi/droid/color/palette/util/ThemeGenUtil.kt

@@ -1,29 +1,79 @@
 package com.kavi.droid.color.palette.util
 
+import android.content.Context
+import android.content.res.Configuration
+import androidx.compose.material3.ColorScheme
+import androidx.compose.material3.darkColorScheme
+import androidx.compose.material3.lightColorScheme
 import androidx.compose.ui.graphics.Color
+import com.kavi.droid.color.palette.extension.base
 import com.kavi.droid.color.palette.extension.hsl
+import com.kavi.droid.color.palette.extension.quaternary
+import com.kavi.droid.color.palette.extension.shadow
 import com.kavi.droid.color.palette.model.AppThemePalette
+import com.kavi.droid.color.palette.model.ColorSchemeThemePalette
 import com.kavi.droid.color.palette.model.ThemeColorPalette
 
 object ThemeGenUtil {
 
+    /**
+     * This is to find out application is in dark mode or not.
+     *
+     * @param context: Context: Android context
+     * @return Boolean: Boolean value says application in dark mode or not.
+     */
+    fun isAppInNightMode(context: Context): Boolean {
+        return when (context.resources.configuration.uiMode.and(Configuration.UI_MODE_NIGHT_MASK)) {
+            Configuration.UI_MODE_NIGHT_YES -> {
+                true
+            }
+            Configuration.UI_MODE_NIGHT_NO,
+            Configuration.UI_MODE_NIGHT_UNDEFINED -> {
+                false
+            }
+            else -> {
+                false
+            }
+        }
+    }
+
     /**
      * Generate theme color set for given color.
      * @param givenColor The color to generate theme color set.
      * @return A theme color set. [AppThemePalette]
      */
+    @Deprecated(
+        message = "This method is deprecated and replaced by generateThemeColorScheme.",
+        replaceWith = ReplaceWith("ThemeGenUtil.generateThemeColorScheme(givenColor = givenColor)")
+    )
     internal fun generateThemeColorSet(givenColor: Color): AppThemePalette {
         val lightColorPalette = generateLightThemeColorSet(givenColor)
         val darkColorPalette = generateDarkThemeColorSet(givenColor)
 
         return AppThemePalette(light = lightColorPalette, dark = darkColorPalette)
     }
 
+    /**
+     * Generate theme color set for given color.
+     * @param givenColor The color to generate theme color set.
+     * @return A theme color set. [ColorSchemeThemePalette]
+     */
+    internal fun generateThemeColorScheme(givenColor: Color): ColorSchemeThemePalette {
+        val lightColorPalette = generateThemeLightColorScheme(givenColor)
+        val darkColorPalette = generateThemeDarkColorScheme(givenColor)
+
+        return ColorSchemeThemePalette(lightColorScheme = lightColorPalette, darkColorScheme = darkColorPalette)
+    }
+
     /**
      * Generate light theme color set for given color.
      * @param givenColor The color to generate theme color set.
      * @return A light theme color set. [ThemeColorPalette]
      */
+    @Deprecated(
+        message = "This method is deprecated and replaced by generateThemeLightColorScheme.",
+        replaceWith = ReplaceWith("ThemeGenUtil.generateThemeLightColorScheme(givenColor = givenColor)")
+    )
     private fun generateLightThemeColorSet(givenColor: Color): ThemeColorPalette {
         return ThemeColorPalette(
             base = givenColor,
@@ -38,11 +88,36 @@ object ThemeGenUtil {
         )
     }
 
+    /**
+     * Generate light theme color set for given color.
+     * @param givenColor The color to generate theme color set.
+     * @return A light theme color set. [ColorScheme]
+     */
+    private fun generateThemeLightColorScheme(givenColor: Color): ColorScheme {
+        val lightColorScheme = lightColorScheme(
+            primary = givenColor,
+            secondary = generateLightSecondaryColor(givenColor),
+            tertiary = generateLightTertiaryColor(givenColor),
+            background = generateLightBackgroundColor(givenColor),
+            onPrimary = Color.White,
+            onSecondary = Color.White
+        )
+        lightColorScheme.base = givenColor
+        lightColorScheme.quaternary = givenColor // This is for use light theme primary color dark theme contrast color
+        lightColorScheme.shadow = Color.Gray
+
+        return lightColorScheme
+    }
+
     /**
      * Generate dark theme color set for given color.
      * @param givenColor he color to generate theme color set.
      * @return A dark theme color set. [ThemeColorPalette]
      */
+    @Deprecated(
+        message = "This method is deprecated and replaced by generateThemeDarkColorScheme.",
+        replaceWith = ReplaceWith("ThemeGenUtil.generateThemeDarkColorScheme(givenColor = givenColor)")
+    )
     private fun generateDarkThemeColorSet(givenColor: Color): ThemeColorPalette {
         return ThemeColorPalette(
             base = givenColor,
@@ -57,6 +132,28 @@ object ThemeGenUtil {
         )
     }
 
+    /**
+     * Generate dark theme color set for given color.
+     * @param givenColor he color to generate theme color set.
+     * @return A dark theme color set. [ColorScheme]
+     */
+    private fun generateThemeDarkColorScheme(givenColor: Color): ColorScheme {
+        val darkColorScheme = darkColorScheme(
+            primary = generateDarkPrimaryColor(givenColor),
+            secondary = generateDarkSecondaryColor(givenColor),
+            tertiary = generateDarkTertiaryColor(givenColor),
+            background = generateDarkBackgroundColor(givenColor),
+            onPrimary = Color.White,
+            onSecondary = Color.Black,
+        )
+
+        darkColorScheme.base = givenColor
+        darkColorScheme.quaternary = generateDarkSecondaryColor(givenColor) // This is for use light theme primary color dark theme contrast color
+        darkColorScheme.shadow = Color.White
+
+        return darkColorScheme
+    }
+
     /**
      * Generate light secondary color for given color.
      */