Skip to content

About

A color picker for Jetpack compose 🎨

Resources

Stars

0 stars

Watchers

0 watching

Forks

 
 

Latest commit

 

History

35 Commits

Folders and files

Repository files navigation

Compose Color Picker

🎨 Color Picker for Jetpack compose

colorPickers

A color picker for Jetpack compose 🎨

This is a fork of mhssn95/compose-color-picker.

Changes from the original:

  • Updated the build to Gradle 9 / AGP 9, while keeping the requirements low (Kotlin 2.0, Compose 1.5)
  • Migrated the dialog from Material 2 to Material 3 (follows the app's theme and dark mode)
  • Added initialColor to all color picker types
  • Fixed the selector briefly flickering at the wrong position when a picker is first shown
  • Published via JitPack

Download

Add the JitPack repository in settings.gradle:

dependencyResolutionManagement {
    repositories {
        maven { url 'https://jitpack.io' }
    }
}

Add the dependency:

implementation 'com.github.nrj022:compose-color-picker:2.0.2'

Requirements: minSdk 21, compileSdk 33, Kotlin 2.0, Compose BOM 2023.08.00 (Compose 1.5) or higher.

Usage

ColorPicker {
    color = it
}

You can provide a type for the color picker as the following.

ColorPicker(
    type = ColorPickerType.Classic()
) {
    color = it
}

Color picker types

  • Classic

    ColorPickerType.Classic(
        showAlphaBar = true,
        initialColor = Color.White
    )
  • Circle

    ColorPickerType.Circle(
        showBrightnessBar = true,
        showAlphaBar = true,
        lightCenter = true,
        initialColor = Color.White // defaults to the center color
    )

    circleColorPickers

  • Ring

    ColorPickerType.Ring(
        ringWidth = 10.dp,
        previewRadius = 80.dp,
        showLightnessBar = true,
        showDarknessBar = true,
        showAlphaBar = true,
        showColorPreview = true,
        initialColor = Color.Red
    )
  • Simple Ring

    ColorPickerType.SimpleRing(
        colorWidth = 20.dp,
        tracksCount = 5,
        sectorsCount = 24,
        initialColor = Color.Red // the closest color in the ring is selected
    )

initialColor is only applied when the picker is first shown; later changes are ignored.

Color Picker Dialog

ColorPickerDialog(
    show = showDialog,
    type = colorPickerType,
    properties = DialogProperties(),
    onDismissRequest = {
        showDialog = false
    },
    onPickedColor = {
        color = it
    },
)

Useful Extensions

  • val color = Color(0xffe1a1c1)
    val alpha = color.alpha() //return alpha value as integer => 255
    val red = color.red() //return red value as integer => 225
    val green = color.green() //return green value as integer => 161
    val blue = color.blue() //return blue value as integer => 193
    val hex = color.toHex() //return argb color as hex string
    val (alpha, red, green, blue) = color.argb() //return an array for all color channels value
  • add Modifier.transparentBackground to draw behind your composable element a transparent effect background

    Box(
        modifier = Modifier
        .width(205.dp)
        .height(300.dp)
        .clip(RoundedCornerShape(32.dp))
        .transparentBackground(verticalBoxesAmount = 16)
        .background(Color.Cyan.copy(alpha = 0.2f))
    )

    transparentBackground

License

Copyright 2022 mhssn

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

About

A color picker for Jetpack compose 🎨

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages