Skip to content

Latest commit

 

History

History
118 lines (97 loc) · 4.55 KB

readme.md

File metadata and controls

118 lines (97 loc) · 4.55 KB
Raw

PaletteLoader

This is a library aiming to simplify the use of Palette, especially in lists such as ListView, GridView, or RecyclerView.

Download

Add the Jitpack repository to your project-level or module-level build.gradle:

repositories {
	maven {
		url "https://jitpack.io"
    }
}

Now, you can add the PaletteLoader dependency:

compile 'com.github.Musenkishi:PaletteLoader:1.1.0'

Usage

Currently PaletteLoader supports classes (and extensions of):

  • View
  • ImageView (masking and background)
  • TextView
  • CardView

If the supplied view is or extends View, PaletteLoader will apply the color to the background. If view extends ImageView and you use .mask(), PaletteLoader will apply the color to the image, not the background. And lastly if view is, or extends TextView, the color will be applied to the text, not the background.

PaletteLoader.with(context, uniqueStringForBitmap) //For reuse purposes uniqueStringForBitmap could be the url for the image.
                        .load(bitmap)
                        .setPaletteRequest(
                            new PaletteRequest(
                                PaletteRequest.SwatchType.REGULAR_VIBRANT,
                                PaletteRequest.SwatchColor.BACKGROUND))
                        .into(view);

Example

In this example Glide is used, which is similar to Picasso:

RequestListener<String, GlideDrawable> glideDrawableRequestListener = new RequestListener<String, GlideDrawable>() {
    @Override
    public boolean onResourceReady(GlideDrawable resource,
                                   String model,
                                   Target<GlideDrawable> target,
                                   boolean isFromMemoryCache,
                                   boolean isFirstResource) {
        Bitmap bitmap = ((GlideBitmapDrawable) resource).getBitmap();
        if (bitmap != null) {
            Context context = viewHolder.bottomBar.getContext();

		    //Set color to a View's background
            PaletteLoader.with(context, model)
                        .load(bitmap)
                        .setPaletteRequest(
                            new PaletteRequest(
                                PaletteRequest.SwatchType.REGULAR_VIBRANT,
                                PaletteRequest.SwatchColor.BACKGROUND))
                        .into(viewHolder.bottomBar);

		    //Set color to text in a TextView
            PaletteLoader.with(context, model)
                        .load(bitmap)
                        .setPaletteRequest(
                            new PaletteRequest(
                                PaletteRequest.SwatchType.REGULAR_VIBRANT,
                                PaletteRequest.SwatchColor.TEXT_TITLE))
                        .into(viewHolder.textViewResolution);

		    //Colorize an ImageView/ImageButton with .mask().
            //Best result is accomplished with a white image (transparent bakground).
            PaletteLoader.with(context, model)
                        .load(bitmap)
                        .fallbackColor(viewHolder.textViewResolution.getCurrentTextColor())
                        .setPaletteRequest(
                            new PaletteRequest(
                                PaletteRequest.SwatchType.REGULAR_VIBRANT,
                                PaletteRequest.SwatchColor.TEXT_TITLE))
                        .mask()
                        .into(viewHolder.imageButton);
            }
            return false;
        }
    };

    Glide.with(viewHolder.bottomBar.getContext())
            .load(imageUrl)
            .fitCenter()
            .placeholder(R.color.Transparent)
            .listener(glideDrawableRequestListener)
            .into(viewHolder.imageView);

PaletteLoader will generate the palette in a seperate thread (up to 5 threads on post-lollipop) and apply the color in the assigned view.

License

Copyright 2015 Freddie Lust-Hed

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.