Giter VIP home page Giter VIP logo

color-extractor's Introduction

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.1.*

Usage

require 'vendor/autoload.php';

use League\ColorExtractor\Client as ColorExtractor;

$client = new ColorExtractor;

$image = $client->loadPng('./some/image.png');

// Get the most used color hex code
$palette = $image->extract();

// Get three most used color hex code
$palette = $image->extract(3);

// Change the Minimum Color Ratio (0 - 1)
// Default: 0
$image->setMinColorRatio(1);
$palette = $image->extract();

Service Providers

Integration with most frameworks would require a bridge package, but for Silex and Laravel 4 a simple service provider will suffice.

Silex

First register ColorExtractorServiceProvider in your application:

use League\ColorExtractor\Silex\ColorExtractorServiceProvider;

// ... create $app
$app->register(new ColorExtractorServiceProvider);

Then you can use like this:

$image = $app['color-extractor']->loadPng('./some/image.png');
...
$palette = $image->extract();

Laravel 4

Find the providers key in app/config/app.php and register the ColorExtractorServiceProvider:

'providers' => array(
    // ...
    'League\ColorExtractor\Laravel\ColorExtractorServiceProvider',
)

Then you can use it exactly the same way as the Silex service provider. If you prefer to use Facades, find the aliases key in app/config/app.php and register the ColorExtractorFacade:

'aliases' => array(
    // ...
    'ColorExtractor' => 'League\ColorExtractor\Laravel\ColorExtractorFacade',
)

Example:

$image = ColorExtractor::loadPng('./some/image.png');
...
$palette = $image->extract();

Contributing

Please see CONTRIBUTING for details.

Credits

License

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

color-extractor's People

Contributors

matthecat avatar grahamcampbell avatar toin0u avatar

Watchers

James Cloos avatar senthilkumar sugumar avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.