phlak/colorizer

Generate persistantly unique colors from a string.

4.0.0 2017-09-06 01:17 UTC

This package is auto-updated.

Last update: 2021-11-04 23:29:18 UTC


README

Colorizer

Join our Community Become a Sponsor One-time Donation
Latest Stable Version Total Downloads License Build Status StyleCI

Generate persistently unique colors from a string.
Created by Chris Kankiewicz (@PHLAK)

Requirements

Install with Composer

composer require phlak/colorizer

Usage

// Import Colorizer
use PHLAK\Colorizer;

// Initialize Colorizer
$colorize = new Colorizer\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 Colorizer\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

For general help and support join our [Spectrum Community](https://spectrum.chat/phlaknet or reach out on Twitter.

Please report bugs to the GitHub Issue Tracker.

Copyright

This project is licensed under the MIT License.