Merge pull request #15 from KvColorPalette/feature/color-blending

Feature/color blending

Author: kavi707

README.md

@@ -22,7 +22,7 @@ This library simplifies the process of building consistent and visually appealin
 ```
 dependencies: [
     ....
-    .package(url: "https://github.com/KvColorPalette/KvColorPalette-iOS", from: "1.3.0"),
+    .package(url: "https://github.com/KvColorPalette/KvColorPalette-iOS", from: "2.0.0"),
 ]
 ```
 

Sources/KvColorPalette-iOS/KvColorPalette.swift

@@ -4,39 +4,43 @@ import Foundation
 import UIKit
 import SwiftUICore
 
-/**
- * This is the KvColorPalette-iOS library.
- */
+
+///
+/// This is the KvColorPalette-iOS library.
+///
 public class KvColorPalette {
 
     nonisolated(unsafe) public static var instance: KvColorPalette = KvColorPalette()
     nonisolated(unsafe) public static var appThemePalette: AppThemePalette? = nil
 
-    /**
-     * This is a basic initialization without a basic color.  When consumer use this initialization, in default KvColorPalette with not
-     * provide a theme color pallet. Consumer can generate their own by invoking `#generateThemeColorPalette(givenColor: KvColor)` method
-     * in the package.
-     */
+    ///
+    /// This is a basic initialization without a basic color.  When consumer use this initialization, in default KvColorPalette with not
+    /// provide a theme color pallet. Consumer can generate their own by invoking `#generateThemeColorPalette(givenColor: KvColor)` method
+    /// in the package.
+    ///
     public init () {}
 
-    /**
-     * KvColorPalette initialization. Consumer can use this to initialize the KvColorPalette 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.
-     */
+    
+    ///
+    /// KvColorPalette initialization. Consumer can use this to initialize the KvColorPalette 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.
+    ///
     public static func initialize(basicColor: Color) {
         appThemePalette = instance.generateThemeColorPalette(givenColor: basicColor)
     }
-    
-    /**
-     * Generate a list of colors with pre-defined color packages. According to the feeding color,
-     * this method generate a list of colors.
-     *
-     * @param givenColor The color to generate the color packages for.
-     * @return A list of colors.
-     */
+        
+    ///
+    /// Generate a list of colors with pre-defined color packages. According to the feeding color,
+    /// this method generate a list of colors.
+    ///
+    /// - Parameters:
+    ///  - givenColor: The color to generate the color packages for.
+    ///
+    /// - Returns: A list of colors.
+    ///
     public func generateColorPalette(givenColor: KvColor, alphaChange: Double = 1) -> [Color] {
         return [
             Mat900Package().getColor(colorName: givenColor.colorName).alphaChange(modifyAlpha: alphaChange).color,
@@ -51,16 +55,17 @@ public class KvColorPalette {
             Mat50Package().getColor(colorName: givenColor.colorName).alphaChange(modifyAlpha: alphaChange).color
         ]
     }
-    
-    /**
-     * Generate a list of colors with alpha values. According to the feeding color,
-     * this method generate a list of colors with different alpha values.
-     *
-     * @param givenColor The color to generate the alpha values for.
-     * @param colorCount The number of colors to generate. In default that returns 10 colors. This accept integer value in a range of 2 - 30.
-     * Even someone passes number more than 30, this will returns only 30 colors.
-     * @return A list of colors with alpha values.
-     */
+        
+    ///
+    /// Generate a list of colors with alpha values. According to the feeding color,
+    /// this method generate a list of colors with different alpha values.
+    ///
+    /// - Parameters:
+    ///  - givenColor: The color to generate the alpha values for.
+    ///  - colorCount: The number of colors to generate. In default that returns 10 colors. This accept integer value in a range of 2 - 30. Even someone passes number more than 30, this will returns only 30 colors.
+    ///
+    /// - Returns: A list of colors with alpha values.
+    ///
     public func generateAlphaColorPalette(givenColor: Color, colorCount: Int = 10) -> [Color] {
         var colorList: [Color] = []
         let reviceColorCount = ColorUtil.validateAndReviseColorCount(colorCount: colorCount)
@@ -73,15 +78,16 @@ public class KvColorPalette {
         return colorList
     }
 
-    /**
-     * Generate a list of colors with brightness property change in given color. According to the feeding color,
-     * this method generate a list of colors with different brightnesses.
-     *
-     * @param givenColor The color to generate the brightness values for.
-     * @param colorCount The number of colors to generate. In default that returns 10 colors. This accept integer value in a range of 2 - 30.
-     * Even someone passes number more than 30, this will returns only 30 colors.
-     * @return A list of colors.
-     */
+    ///
+    /// Generate a list of colors with brightness property change in given color. According to the feeding color,
+    /// this method generate a list of colors with different brightnesses.
+    ///
+    /// - Parameters:
+    ///  - givenColor: The color to generate the brightness values for.
+    ///  - colorCount: The number of colors to generate. In default that returns 10 colors. This accept integer value in a range of 2 - 30. Even someone passes number more than 30, this will returns only 30 colors.
+    ///
+    /// - Returns:  A list of colors.
+    ///
     public func generateBrightnessColorPalette(givenColor: Color, colorCount: Int = 10) -> [Color] {
         let hue = givenColor.hsl.hue
         let saturation = givenColor.hsl.saturation
@@ -97,15 +103,16 @@ public class KvColorPalette {
         return colorList
     }
 
-    /**
-     * Generate a list of colors with saturation property change in given color. According to the feeding color,
-     * this method generate a list of colors with different saturations.
-     *
-     * @param givenColor The color to generate the saturation values for.
-     * @param colorCount The number of colors to generate. In default that returns 10 colors. This accept integer value in a range of 2 - 30.
-     * Even someone passes number more than 30, this will returns only 30 colors.
-     * @return A list of colors.
-     */
+    ///
+    /// Generate a list of colors with saturation property change in given color. According to the feeding color,
+    /// this method generate a list of colors with different saturations.
+    ///
+    /// - Parameters:
+    ///  - givenColor: The color to generate the saturation values for.
+    ///  - colorCount: The number of colors to generate. In default that returns 10 colors. This accept integer value in a range of 2 - 30. Even someone passes number more than 30, this will returns only 30 colors.
+    ///
+    /// - Returns: A list of colors.
+    ///
     public func generateSaturationColorPalette(givenColor: Color, colorCount: Int = 10) -> [Color] {
         let hue = givenColor.hsl.hue
         let brightness = givenColor.hsl.brightness
@@ -121,23 +128,27 @@ public class KvColorPalette {
         return colorList
     }
 
-    /**
-     * Generate a theme color pallet. According to the feeding color,
-     * this method generate a theme color pallet.
-     *
-     * @param givenColor The color to generate the theme color pallet for.
-     * @return A theme color pallet.
-     */
+    ///
+    /// Generate a theme color pallet. According to the feeding color,
+    /// this method generate a theme color pallet.
+    ///
+    /// - Parameters:
+    ///  - givenColor: The color to generate the theme color pallet for.
+    ///
+    /// - Returns:  A theme color pallet.
+    ///
     public func generateThemeColorPalette(givenColor: Color) -> AppThemePalette {
         return ThemeGenUtil.generateThemeColorSet(givenColor: givenColor)
     }
 
-    /**
-     * This method finds the closest KvColor available in the KvColorPalette-iOS to the given color
-     *
-     * @param givenColor: The color to find closest KvColor from color packages
-     * @return KvColor
-     */
+    ///
+    /// This method finds the closest KvColor available in the `KvColorPalette-iOS` to the given color
+    ///
+    /// - Parameters:
+    ///  - givenColor: The color to find closest KvColor from color packages
+    ///
+    /// - Returns: `KvColor`
+    /// 
     public func findClosestKvColor(givenColor: Color) -> KvColor {
         return ColorUtil.findClosestColor(givenColor: givenColor)
     }