https://github.com/fennifith/colorpickerdialog
A simple dialog making it quick and easy to add color picking functionality to any app.
https://github.com/fennifith/colorpickerdialog
android android-library android-ui color-picker dialog image-picker
Last synced: 9 months ago
JSON representation
A simple dialog making it quick and easy to add color picking functionality to any app.
- Host: GitHub
- URL: https://github.com/fennifith/colorpickerdialog
- Owner: fennifith
- License: apache-2.0
- Created: 2017-01-19T10:54:16.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2021-03-20T23:19:20.000Z (over 5 years ago)
- Last Synced: 2025-04-05T04:11:13.277Z (about 1 year ago)
- Topics: android, android-library, android-ui, color-picker, dialog, image-picker
- Language: Java
- Homepage: https://jitpack.io/#me.jfenn/ColorPickerDialog
- Size: 2.17 MB
- Stars: 137
- Watchers: 4
- Forks: 20
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
ColorPickerDialog
[](https://jitpack.io/#me.jfenn/ColorPickerDialog)
[](https://discord.jfenn.me/)
=====
ColorPickerDialog is a simple dialog making it quick and easy to add a color picker functionality to any app.
For testing and experimentation purposes, a sample apk can be downloaded [here](https://jfenn.me/projects/colorpickerdialog).
| RGB(A) Picker | HSV Picker | Preset Picker | Image Picker (Tab) | Image Picker (Images) | Dark Theme |
|---------------|------------|---------------|--------------------|-----------------------|------------|
|  |  |  |  |  |  |
## Usage
### Setup
This project is published on [JitPack](https://jitpack.io), which you can add to your project by copying the following to your root build.gradle at the end of "repositories".
```gradle
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}
```
To add the dependency, copy this line into your app module's build.gradle file.
```gradle
implementation 'me.jfenn.ColorPickerDialog:base:0.2.2'
```
### Creating a Dialog
The basic requirements for the dialog are a default color and a listener, and though none of them _have_ to be specified, it is usually a good idea. You can create a simple dialog fragment using the snippet below:
```java
new ColorPickerDialog()
.withColor(color) // the default / initial color
.withListener(new OnColorPickedListener() {
@Override
public void onColorPicked(@Nullable ColorPickerDialog dialog, int color) {
// a color has been picked; use it
}
})
.show(getSupportFragmentManager(), "colorPicker");
```
Alternatively, if you are creating the dialog from a fragment, you should use `getChildFragmentManager()` instead of `getSupportFragmentManager()`.
### Alpha
You can call `.withAlpha(boolean)` to specify whether you want the color's alpha channel to be configurable by the user (if not, all output colors will be fully opaque). This option is enabled by default. A somewhat unnecessary example:
```java
new ColorPickerDialog(this)
.withAlphaEnabled(false) // disable the alpha channel
.withListener(...)
.show();
```
### Alternative Pickers
By default, the dialog gives the user three ways to enter a color; they can use RGB sliders, HSV sliders, or enter the hex value into the text box at the top.
There are also some alternative pickers that can be enabled to serve a few different purposes.
#### Presets
The `.withPresets()` method will enable the "preset" color picker, which simply displays a grid of preset colors for the user to choose from. These colors can be configured by passing them (either as an array or varargs) to the `.withPresets()` method, like below:
```java
new ColorPickerDialog()
.withPresets(Color.RED, Color.GREEN, Color.BLUE)
.withListener(...)
.show(getSupportFragmentManager(), "colorPicker");
```
#### Images
There is an optional dependency that adds image picking functionality to the color picker; the user can select an image and then select a color from the image they have chosen.
To enable it, add the following to your `build.gradle` file along with the dependency from before:
```java
implementation 'me.jfenn.ColorPickerDialog:imagepicker:0.2.2'
```
Next, you will need to declare the following permissions in your `AndroidManifest.xml` (the library does not do it for you).
```xml
```
Now you should be able to add an image picker to your dialog by calling `.withPicker(ImagePickerView.class)` like below:
```java
new ColorPickerDialog()
.withPicker(ImagePickerView.class)
.withListener(...)
.show(getSupportFragmentManager(), "colorPicker");
```
### Theming
You can theme this dialog by passing your custom theme to `.withTheme(int)`. Support for full "runtime" theming may come later, but now is not later, so you can't do that yet. Here's an example of a `ColorPickerDialog` with a basic dark theme, demonstrating some of the options that you can specify.
```java
new ColorPickerDialog()
.withTheme(R.style.ColorPickerDialog_Dark)
.show(getSupportFragmentManager(), "colorPicker");
```
```xml
<item name="redColor">#FF5252</item>
<item name="greenColor">#FF5252</item>
<item name="blueColor">#536DFE</item>
<item name="neutralColor">#FFFFFF</item>
```
The `redColor`, `greenColor`, and `blueColor` attributes affect the RGB sliders, and the `neutralColor` attribute changes the "neutral" colors of the others, including the alpha slider and the handles of the sliders in the HSL picker.
#### Rounded Corners
The dialog also supports custom values for the rounded corners, which you can specify by calling `.withCornerRadius(float)` with the dp measurement of the corner radius, or `.withCornerRadiusPx(int)` with a pixel measurement.
## Other Documentation
Not only am I lazy, I also miss things, so this page may not describe every feature that this library is capable of. However, the majority of this library's documentation is actually written as javadocs within the source code. You can find the generated documentation pages for it [here](https://jfenn.me/projects/colorpickerdialog/docs/).
### Proguard / Minification
For those using the R8 compiler, this library's [proguard rules](./base/consumer-rules.pro) should be conveniently bundled with the library already - otherwise, you will need to add them to your app's `proguard-rules.pro` file yourself to prevent running into any issues with `minifyEnabled` and the like.