phlak/colorizer

Generate persistantly unique colors from a string.

5.0.0 2024-12-06 23:19 UTC

Requires

• php: ^8.2 || ^8.3 || ^8.4
• webmozart/assert: ^1.11

Requires (Dev)

• phlak/coding-standards: ^3.0
• phpstan/phpstan: ^2.0
• phpunit/phpunit: ^11

MIT

• Chris Kankiewicz

• color
• colorize
• color hash

README

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

Requirements

• PHP >= 8.1

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 GitHub Discussion or reach out on Bluesky.

Please report bugs to the GitHub Issue Tracker.

Copyright

This project is licensed under the MIT License.