Skip to content

Commit d132ec4

Browse files
committed
Add a code documentation to blend color picker
1 parent da9adee commit d132ec4

5 files changed

Lines changed: 13 additions & 10 deletions

File tree

kv-color-picker/gradle.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
kvColorPaletteGroupId=com.github.KvColorPalette
22
kvColorPickerArtifactId=KvColorPicker-Android
3-
kvColorPickerVersion=2.3.0
3+
kvColorPickerVersion=3.0.0

kv-color-picker/src/main/kotlin/com/kavi/droid/color/picker/ui/pickers/BlendColorPicker.kt

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,17 @@ import com.kavi.droid.color.palette.util.ColorUtil
3939
import com.kavi.droid.color.picker.R
4040
import com.kavi.droid.color.picker.ui.common.SliderHue
4141

42+
/**
43+
* A composable function that creates a color picker UI to select color by selecting two colors and blend.
44+
* This component contains two color spectrum(s) to select first and second color to blend and one slider, that consumer
45+
* can change how blended color bias to first or second color.
46+
* By selecting first and second color then by adjusting color bias value, consumer can select or generate their desired color.
47+
*
48+
* @param modifier: Modifier: The modifier to apply to this layout.
49+
* @param onColorSelected: (selectedColor: Color) -> Unit: Callback to invoke when a color is selected.
50+
*
51+
* @return @Composable: A color picker UI for selecting blended color.
52+
*/
4253
@Composable
4354
fun BlendColorPicker(
4455
modifier: Modifier = Modifier,

kv-color-picker/src/main/kotlin/com/kavi/droid/color/picker/ui/pickers/GridColorPicker.kt

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,17 +23,15 @@ import androidx.compose.ui.Modifier
2323
import androidx.compose.ui.draw.shadow
2424
import androidx.compose.ui.graphics.Color
2525
import androidx.compose.ui.res.stringResource
26-
import androidx.compose.ui.text.input.TextFieldValue
2726
import androidx.compose.ui.text.style.TextAlign
2827
import androidx.compose.ui.unit.dp
2928
import androidx.compose.ui.unit.sp
3029
import com.kavi.droid.color.palette.color.MatPackage
31-
import com.kavi.droid.color.palette.util.ColorUtil
3230
import com.kavi.droid.color.picker.R
3331
import com.kavi.droid.color.picker.ui.common.ColorColum
3432

3533
/**
36-
* A composable function that creates a grid grid to select colors. This color grid is created with
34+
* A composable function that creates a grid to select colors. This color grid is created with
3735
* 16 predefined major colors and those color's 10 color variances.
3836
*
3937
* @param modifier: Modifier: The modifier to apply to this layout.

kv-color-picker/src/main/kotlin/com/kavi/droid/color/picker/ui/pickers/HSLAColorPicker.kt

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,19 +15,16 @@ import androidx.compose.runtime.LaunchedEffect
1515
import androidx.compose.runtime.derivedStateOf
1616
import androidx.compose.runtime.getValue
1717
import androidx.compose.runtime.mutableFloatStateOf
18-
import androidx.compose.runtime.mutableStateOf
1918
import androidx.compose.runtime.remember
2019
import androidx.compose.runtime.saveable.rememberSaveable
2120
import androidx.compose.ui.Modifier
2221
import androidx.compose.ui.draw.shadow
2322
import androidx.compose.ui.graphics.Color
2423
import androidx.compose.ui.res.stringResource
25-
import androidx.compose.ui.text.input.TextFieldValue
2624
import androidx.compose.ui.text.style.TextAlign
2725
import androidx.compose.ui.unit.dp
2826
import androidx.compose.ui.unit.sp
2927
import com.kavi.droid.color.palette.extension.hsl
30-
import com.kavi.droid.color.palette.util.ColorUtil
3128
import com.kavi.droid.color.picker.R
3229
import com.kavi.droid.color.picker.ui.common.AlphaSlider
3330
import com.kavi.droid.color.picker.ui.common.ColorSaturationAndLightnessSlider

kv-color-picker/src/main/kotlin/com/kavi/droid/color/picker/ui/pickers/RGBAColorPicker.kt

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,18 +15,15 @@ import androidx.compose.runtime.LaunchedEffect
1515
import androidx.compose.runtime.derivedStateOf
1616
import androidx.compose.runtime.getValue
1717
import androidx.compose.runtime.mutableFloatStateOf
18-
import androidx.compose.runtime.mutableStateOf
1918
import androidx.compose.runtime.remember
2019
import androidx.compose.runtime.saveable.rememberSaveable
2120
import androidx.compose.ui.Modifier
2221
import androidx.compose.ui.draw.shadow
2322
import androidx.compose.ui.graphics.Color
2423
import androidx.compose.ui.res.stringResource
25-
import androidx.compose.ui.text.input.TextFieldValue
2624
import androidx.compose.ui.text.style.TextAlign
2725
import androidx.compose.ui.unit.dp
2826
import androidx.compose.ui.unit.sp
29-
import com.kavi.droid.color.palette.util.ColorUtil
3027
import com.kavi.droid.color.picker.R
3128
import com.kavi.droid.color.picker.ui.common.AlphaSlider
3229
import com.kavi.droid.color.picker.ui.common.ColorSlider

0 commit comments

Comments
 (0)