https://github.com/davide-gheri/laravel-dominant-color

https://github.com/davide-gheri/laravel-dominant-color

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/davide-gheri/laravel-dominant-color
• Owner: Davide-Gheri
• Created: 2016-12-12T13:25:35.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2016-12-12T21:53:27.000Z (about 8 years ago)
• Last Synced: 2024-04-20T00:52:21.065Z (8 months ago)
• Language: PHP
• Size: 6.84 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# laravel-dominant-color

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`.

```php

'providers' => [

    ...

    Ghero\DominantColor\DominantColorServiceProvider::class,

    ...    

];

```

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

```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:

```html



```

### 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