README.md

Open Color

This package provides access to the Open Color palette, an open-source color scheme optimized for UI design.

Installation

composer require phpcolor/open-color:^1.0

The package works standalone. Install phpcolor/phpcolor only when using palette():

composer require phpcolor/phpcolor

Usage

Create Colors Instance

use PhpColor\Colors\OpenColor\OpenColorColors as OpenColor;

$colors = OpenColor::colors();

Color Names

use PhpColor\Colors\OpenColor\OpenColorColors as OpenColor;

$colors = OpenColor::colors();

$names = $colors->getNames();
// 'white', 'black', 'gray', 'red', 'pink', 'grape',
// 'violet', 'indigo', 'blue', 'cyan', 'teal', 'green',
// 'lime', 'yellow', 'orange'

Color Shades

use PhpColor\Colors\OpenColor\OpenColorColors as OpenColor;

$colors = OpenColor::colors();

// Get shades for a color (0-9)
$shades = $colors->getShades('gray');
// [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]

Color Values

use PhpColor\Colors\OpenColor\OpenColorColors as OpenColor;

$colors = OpenColor::colors();

// Default shade is 5
echo $colors->blue;                // #339AF0
echo $colors->blue();              // #339AF0

// Specify shade (0-9)
echo $colors->blue(7);             // #1C7ED6
echo $colors->get('red', 9);       // #C92A2A

// White and black have no shades
echo $colors->white;               // #FFFFFF
echo $colors->black;               // #000000

PHPColor Palette

use PhpColor\Color\Palette\ColorPaletteInterface;
use PhpColor\Colors\OpenColor\OpenColorColors as OpenColor;

$palette = OpenColor::colors()->palette('blue');
assert($palette instanceof ColorPaletteInterface);

echo $palette->get(5)->toHex(); // #339af0

Colors without shades also return a one-color palette:

$white = OpenColor::colors()->palette('white');
echo $white->get('white')->toHex(); // #ffffff

Calling palette() without phpcolor/phpcolor installed throws a LogicException with the installation command.

Credits

The colors listed in this project are based on Open Color.

License

This PHPColor package is released under the MIT license.