ghero/laravel-dominant-color

A package that generates a base64 encoded GIF with the dominant color of the given image (for lazy loading use)

v1.0 2016-12-12 21:44 UTC

Requires

• php: >=5.4.0
• ext-imagick: *

MIT

• Davide Gheri

• lazy load
• laravel 5
• dominant color

README

A package that generates a base64 encoded GIF with the dominant color of the given image (for lazy loading use)

Requires the php Imagik library to work!

Installation

Require the package via composer

composer require ghero/laravel-dominant-color

Include the service provider within your providers in config/app.php.

'providers' => [
    ...
    Ghero\DominantColor\DominantColorServiceProvider::class,
    ...    
];

Next, add the class alias to the aliases array of config/app.php.

'aliases' => [
    ...
    'DominantColor' => Ghero\DominantColor\Facades\DominantColor::class,
    ...    
];

Usage

Simply call DominantColor::create($file); passing a valid url to an Image or an Imagick instance

this will generate a string with the base 64 encoded 1x1 GIF (ex. data:image/gif;base64,R0lGODlhAQABAIABAI2JggAAACwAAAAAAQABAAACAkQBADs=) The GIF is only 1 color, the dominant color of the image

You can then easily set this string as src attribute specifing the desired width and height:

<img src='data:image/gif;base64,R0lGODlhAQABAIABAI2JggAAACwAAAAAAQABAAACAkQBADs=' width='200' height='200'/>

Other available methods

Get the color

You can also get just the hex code of the dominant color using $color = DominantColor::setColor($file)->getColor(); The default output will be a plain hex code without the starting "#". You can customize the output passing an optional parameter to the getColor method: Available outputs:

• "hex": outputs complete hex code (ex. #FFFFFF)
• "rgb": outputs Rgb format string (ex. 255,255,255)
• "array": outputs Rgb format as an array (ex. ['r' => 255, 'g' => 255, 'b' => 255])

Get the GIF

To get the base 64 encoded GIF from an hex code, just use $gif = DominantColor::setGif($color)->getGif().

Todo

• Add GD and Gmagick support