Color Preference


Source link: https://github.com/kizitonwose/colorpreference

Color Preference

An Android library for creating a nice color picker in the preference screen. You can use the inbuilt picker or any other color picker of your choice. The library can be used with the standard preference classes or the support-preference-v7/v14 classes.

Preview

Get the sample apk here

Also checkout the sample module here

Setup

Gradle

Add this to your project level build.gradle:

allprojects {
  repositories {

  jcenter()
  maven {
 url "https://jitpack.io" 
}
  
}
 
}

Add this to your app build.gradle:

dependencies {
  compile 'com.github.kizitonwose.colorpreference:core:1.0.4' 
}

If you are using the support-preference-v7/v14 library, you should use this in your app build.gradle instead:

dependencies {
  compile 'com.github.kizitonwose.colorpreference:support:1.0.4' 
}

Usage

Just like every other preference object, you add it to the XML file of your Preference screen.

Preference usage
<PreferenceScreen>
<com.kizitonwose.colorpreference.ColorPreference
android:defaultValue="@color/color_default"
android:key="@string/pref_key" />
<CheckBoxPreference
... />
<SwitchPreference
... />  </PreferenceScreen>
Support Preference-v7/v14 usage
<android.support.v7.preference.PreferenceScreen>
 <com.kizitonwose.colorpreferencecompat.ColorPreferenceCompat
android:defaultValue="@color/color_default"
android:key="@string/pref_key" />
<android.support.v7.preference.SwitchPreferenceCompat
... />
 </android.support.v7.preference.PreferenceScreen>

The default implementation is the circle color view. For custom settings, add the app namespace to your XML file:

xmlns:app="http://schemas.android.com/apk/res-auto"

Now you can use the custom attributes. All custom attributes are available for the ColorPreference and ColorPreferenceCompat classes.

<com.kizitonwose.colorpreference.ColorPreference  android:defaultValue="@color/color_default"  android:key="@string/pref_key"  android:summary="@string/pref_summary"  android:title="@string/pref_title"  app:colorShape="circle"  app:colorChoices="@array/color_choices"  app:viewSize="large"  app:numColumns="5"  app:showDialog="true" />

Attributes

Attribute name Description Default value
colorShape The shape of the color view( circle or square) circle
colorChoices An array of colors to show on the dialog An internal array
viewSize The size of the color view( normal or large) large
numColumns The number of columns for the colors on the dialog 5
showDialog If false, the user can suppress the in-built dialog and then show a custom color picker. To save the color from the custom picker, just call setValue(int newColor) true

Custom Picker sample

You can find a working example of how to use a custom color picker in the included sample module. Actually, all you have to do is include app:showDialog="false" in the preference item to suppress the inbuilt picker, then when you get your color from the custom picker, call setValue(int newColor) method of the ColorPreference(or ColorPreferenceCompat) class and pass in the color. This saves the color and updates the view accordingly.

The custom picker in the sample uses the Lobster Color Picker Library. You can use any color picker of your choice.

Extras

If you want to use the inbuilt color picker in any activity as a simple color picker, you can use the ColorDialog.Builder class. A working sample is also included in the sample module.

// The context shuould be an Activity which implements ColorDialog.OnColorSelectedListener new ColorDialog.Builder(this)
.setColorShape(ColorShape.CIRCLE) //CIRCLE or SQUARE
.setColorChoices(R.array.color_choices) //an array of colors
.setSelectedColor(Color.GREEN) //the checked color
.setTag("TAG") // tags can be useful when multiple components use the picker within an activity
.show();
 

Activity usage example

public class ExampleActivity extends Activity implements ColorDialog.OnColorSelectedListener {

// set these tags when building the color picker dialog  // if you have only one picker in an Activity, you don't need a tag  private final String TOOLBAR_PICKER_TAG = "toolbar";
  private final String BACKGROUND_PICKER_TAG = "background";

 @Override
  protected void onCreate(Bundle savedInstanceState) {

// activity initialization code
  
}

@Override
  public void onColorSelected(int newColor, String tag) {

switch (tag){

 case TOOLBAR_PICKER_TAG:
  //change the toolbar color with newColor
  break;
 case BACKGROUND_PICKER_TAG:
  //change the activity background color with newColor
  break;

}

  
}
 
}

Changelog

See the changelog file.

Thanks

Thanks to Roman Nurik for his initial implementation.

License

Copyright (C) 2016 Kizito Nwose  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. 

Resources

SVGMapView allows to display SVG on Android platform.

Nice seekbar for Android platform.

Easy way to add TextView above other views.

LoadingButton is a custom view that shows and hide progressBar with text animation. You can specify the text animation direction.

A project which showcases usage of Dagger, RxJava and Retrolambda among other open source libraries.

Font manager for Android.

Topics


2D Engines   3D Engines   9-Patch   Action Bars   Activities   ADB   Advertisements   Analytics   Animations   ANR   AOP   API   APK   APT   Architecture   Audio   Autocomplete   Background Processing   Backward Compatibility   Badges   Bar Codes   Benchmarking   Bitmaps   Bluetooth   Blur Effects   Bread Crumbs   BRMS   Browser Extensions   Build Systems   Bundles   Buttons   Caching   Camera   Canvas   Cards   Carousels   Changelog   Checkboxes   Cloud Storages   Color Analysis   Color Pickers   Colors   Comet/Push   Compass Sensors   Conferences   Content Providers   Continuous Integration   Crash Reports   Credit Cards   Credits   CSV   Curl/Flip   Data Binding   Data Generators   Data Structures   Database   Database Browsers   Date &   Debugging   Decompilers   Deep Links   Dependency Injections   Design   Design Patterns   Dex   Dialogs   Distributed Computing   Distribution Platforms   Download Managers   Drawables   Emoji   Emulators   EPUB   Equalizers &   Event Buses   Exception Handling   Face Recognition   Feedback &   File System   File/Directory   Fingerprint   Floating Action   Fonts   Forms   Fragments   FRP   FSM   Functional Programming   Gamepads   Games   Geocaching   Gestures   GIF   Glow Pad   Gradle Plugins   Graphics   Grid Views   Highlighting   HTML   HTTP Mocking   Icons   IDE   IDE Plugins   Image Croppers   Image Loaders   Image Pickers   Image Processing   Image Views   Instrumentation   Intents   Job Schedulers   JSON   Keyboard   Kotlin   Layouts   Library Demos   List View   List Views   Localization   Location   Lock Patterns   Logcat   Logging   Mails   Maps   Markdown   Mathematics   Maven Plugins   MBaaS   Media   Menus   Messaging   MIME   Mobile Web   Native Image   Navigation   NDK   Networking   NFC   NoSQL   Number Pickers   OAuth   Object Mocking   OCR Engines   OpenGL   ORM   Other Pickers   Parallax List   Parcelables   Particle Systems   Password Inputs   PDF   Permissions   Physics Engines   Platforms   Plugin Frameworks   Preferences   Progress Indicators   ProGuard   Properties   Protocol Buffer   Pull To   Purchases   Push/Pull   QR Codes   Quick Return   Radio Buttons   Range Bars   Ratings   Recycler Views   Resources   REST   Ripple Effects   RSS   Screenshots   Scripting   Scroll Views   SDK   Search Inputs   Security   Sensors   Services   Showcase Views   Signatures   Sliding Panels   Snackbars   SOAP   Social Networks   Spannable   Spinners   Splash Screens   SSH   Static Analysis   Status Bars   Styling   SVG   System   Tags   Task Managers   TDD &   Template Engines   Testing   Testing Tools   Text Formatting   Text Views   Text Watchers   Text-to   Toasts   Toolkits For   Tools   Tooltips   Trainings   TV   Twitter   Updaters   USB   User Stories   Utils   Validation   Video   View Adapters   View Pagers   Views   Watch Face   Wearable Data   Wearables   Weather   Web Tools   Web Views   WebRTC   WebSockets   Wheel Widgets   Wi-Fi   Widgets   Windows   Wizards   XML   XMPP   YAML   ZIP Codes