phlak/colorizer

Generate persistantly unique colors from a string.

3.0.2 2017-05-24 00:22 UTC

README

Colorizer

Latest Stable Version Total Downloads Author License Build Status StyleCI

Generate persistently unique colors from a string.

Like this project? Keep me caffeinated by making a donation.

Requirements

Install with Composer

composer require phlak/colorizer

Usage

// Import Colorizer
use Colorizer\Colorize;

// Initialize Colorizer
$colorize = new Colorize();

// Generate a Color object from 'foo'
$color = $colorize->text('foo'); // Returns a new Color object

// Get the red, green and blue values
$color->red;    // 165
$color->green;  // 196
$color->blue;   // 254

// Generate a hex color code
$color->hex();  // Returns '#a5c4fe'

// Generate a RGB color code
$color->rgb();  // Returns 'rgb(165, 196, 254)'

Normalizing Colors

You can enforce RGB values to fall within a certain range to prevent colors from being too bright or dark. This is possible by passing minimum and maximum normalization values (0-255) to the Colorize class on initialization:

$colorize = new Colorize(64, 224);

or fluently:

$colorize->text('foo')->normalize(64, 224)->rgb();  // Returns 'rgb(165, 196, 224)'

Changelog

A list of changes can be found on the GitHub Releases page.

Troubleshooting

Please report bugs to the GitHub Issue Tracker.

Copyright

This project is licensed under the MIT License.