Technology moves fast! ⚡ Don't get left behind.🚶 Subscribe to our mailing list to keep up with latest and greatest in open source projects! 🏆


Subscribe to our mailing list

color-extractor

Extract colors from an image like a human would do.

Subscribe to updates I use color-extractor


Statistics on color-extractor

Number of watchers on Github 821
Number of open issues 5
Average time to close an issue about 2 months
Main language PHP
Average time to merge a PR 2 months
Open pull requests 2+
Closed pull requests 7+
Last commit over 2 years ago
Repo Created almost 6 years ago
Repo Last Updated about 1 year ago
Size 712 KB
Homepage thephpleague.com
Organization / Authorthephpleague
Contributors7
Page Updated
Do you use color-extractor? Leave a review!
View open issues (5)
View color-extractor activity
View on github
Fresh, new opensource launches 🚀🚀🚀
Trendy new open source projects in your inbox! View examples

Subscribe to our mailing list

Evaluating color-extractor for your project? Score Explanation
Commits Score (?)
Issues & PR Score (?)

ColorExtractor

Build Status Total Downloads Latest Stable Version

Extract colors from an image like a human would do.

Install

Via Composer

$ composer require league/color-extractor:0.3.*

Usage

require 'vendor/autoload.php';

use League\ColorExtractor\Color;
use League\ColorExtractor\ColorExtractor;
use League\ColorExtractor\Palette;

$palette = Palette::fromFilename('./some/image.png');

// $palette is an iterator on colors sorted by pixel count
foreach($palette as $color => $count) {
    // colors are represented by integers
    echo Color::fromIntToHex($color), ': ', $count, "\n";
}

// it offers some helpers too
$topFive = $palette->getMostUsedColors(5);

$colorCount = count($palette);

$blackCount = $palette->getColorCount(Color::fromHexToInt('#000000'));


// an extractor is built from a palette
$extractor = new ColorExtractor($palette);

// it defines an extract method which return the most representative colors
$colors = $extractor->extract(5);

Handling transparency

By default any pixel with alpha value greater than zero will be discarded. This is because transparent colors are not perceived as is. For example fully transparent black would be seen white on a white background. So if you want to take transparency into account when building a palette you have to specify this background color. You can do this with the second argument of Palette constructors. Its default value is null, meaning a color won't be added to the palette if its alpha component exists and is greater than zero.

You can set it as an integer representing the color, then transparent colors will be blended before addition to the palette.

// we set a white background so fully transparent colors will be added as white in the palette
// pure red #FF0000 at 50% opacity will be stored as #FF8080 as it would be perceived
$palette = Palette::fromFilename('./some/image.png', Color::fromHexToInt('#FFFFFF'));

Contributing

Please see CONTRIBUTING for details.

Credits

License

The MIT License (MIT). Please see License File for more information.

color-extractor open issues Ask a question     (View All Issues)
  • almost 3 years Request: is it possible for the library to offer sorting the colours light to dark?
  • almost 3 years Palette.getMostUsedColors() getting different values depending on OS / PHP version
  • over 3 years Palette::fromImagick()
  • over 5 years speed
color-extractor open pull requests (View All Pulls)
  • add Imagick support
  • ability to convert int and hex to rgb + tests
color-extractor questions on Stackoverflow (View All Questions)
  • Trying to get property of non-object laravel using color-extractor
color-extractor list of languages used
Other projects in PHP