Skip to content

README.md

Latest commit

 

History

History
82 lines (53 loc) · 1.83 KB

README.md

File metadata and controls

82 lines (53 loc) · 1.83 KB
Raw

Pico Colors

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

Pico Colors

Installation

composer require phpcolor/pico-colors:^1.0

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

composer require phpcolor/phpcolor

Usage

Color names

use PhpColor\Colors\Pico\PicoColors as Pico;

$colors = Pico::colors();

$names = $colors->getNames(); 
// 'red', 'pink', 'fuchsia', 'purple', 'violet', 'indigo'
// 'blue', 'azure', 'cyan', 'jade', 'green', 'lime', 'yellow',
// 'amber', 'pumpkin', 'orange', 'sand', 'grey', 'zinc', 'slate'

Color shades

use PhpColor\Colors\Pico\PicoColors as Pico;

$colors = Pico::colors();

$shades = $colors->getShades(); 
// 50, 100, 150, ... ,850, 900, 950

Color values

use PhpColor\Colors\Pico\PicoColors as Pico;

$colors = Pico::colors();

echo $colors->azure;             // #017FC0
echo $colors->azure();           // #017FC0
echo $colors->azure(500);        // #017FC0

echo $colors->get('azure');      // #017FC0
echo $colors->get('azure', 500); // #017FC0

PHPColor palette

use PhpColor\Color\Palette\ColorPaletteInterface;
use PhpColor\Colors\Pico\PicoColors as Pico;

$palette = Pico::colors()->palette('azure');
assert($palette instanceof ColorPaletteInterface);

echo $palette->get(500)->toHex(); // #017fc0

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

Pico Colors

Credits

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

License

This PHPColor package is released under the MIT license.