Skip to content

README.md

Latest commit

 

History

History
93 lines (59 loc) · 1.94 KB

README.md

File metadata and controls

93 lines (59 loc) · 1.94 KB
Raw

Primer Colors

This package provides access to the color palettes used in Primer CSS.

Primer Colors

Installation

composer require phpcolor/primer-colors:^1.0

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

composer require phpcolor/phpcolor

Usage

Color themes

use PhpColor\Colors\Primer\PrimerColors as Primer;

$colors = Primer::colors();
$colors = Primer::colors('light');

$colors = Primer::colors('dark');

Color names

use PhpColor\Colors\Primer\PrimerColors as Primer;

$colors = Primer::colors();

$names = $colors->getNames(); 
// 'gray', 'blue', 'green', 'yellow', 'orange',
// 'red', 'purple', 'pink', 'coral'

Color shades

use PhpColor\Colors\Primer\PrimerColors as Primer;

$colors = Primer::colors();

$shades = $colors->getShades(); 
// 0, 1, 2, 3, 4, 5, 6, 7, 8, 9

Color values

use PhpColor\Colors\Primer\PrimerColors as Primer;

$colors = Primer::colors();

echo $colors->coral;           // #C4432B
echo $colors->coral();         // #C4432B
echo $colors->coral(5);        // #C4432B

echo $colors->get('coral');    // #C4432B
echo $colors->get('coral', 5); // #C4432B

PHPColor palette

use PhpColor\Color\Palette\ColorPaletteInterface;
use PhpColor\Colors\Primer\PrimerColors as Primer;

$palette = Primer::colors('dark')->palette('coral');
assert($palette instanceof ColorPaletteInterface);

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

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

Primer Colors

Credits

The colors listed in this project are based on the colors used by Primer.

License

This PHPColor package is released under the MIT license.