A little library to deal with color conversions
A little library to handle color conversions. Currently supports rgb, rgba, hex, hsl and hsla formats.
$rgb = Rgb::fromString('rgb(55,155,255)');echo $rgb->red(); // 55 echo $rgb->green(); // 155 echo $rgb->blue(); // 255
echo $rgb; // rgb(55,155,255)
$rgba = $rgb->toRgba(); //
Spatie\Color\Rgba
$rgba->alpha(); // 1 echo $rgba; // rgba(55,155,255,1)$hex = $rgb->toHex(); //
Spatie\Color\Hex
echo $hex; // #379bff$hsl = $rgb->toHsl(); echo $hsl; // hsl(210,100%,100%)
We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.
You can install the package via composer:
composer require spatie/color
The
Colorpackage contains a separate class per color format, which each implement a
Colorinterface.
There are five classes which implement the
Colorinterface:
Hex
Hsl
Hsla
Rgb
Rgba
interface Spatie\Color\Color
fromString(): Color
Parses a color string and returns a
Colorimplementation, depending on the format of the input string.
Hex::fromString('#000000'); Rgba::fromString('rgba(255, 255, 255, 1)'); Hsla::fromString('hsla(360, 100%, 100%, 1)');
Throws an
InvalidColorValueexception if the string can't be parsed.
Rgb,Rgba,HslandHslastrings are allowed to have spaces.rgb(0,0,0)is just as valid asrgb(0, 0, 0).
red(): int|string
Return the value of the
redcolor channel.
Hex::fromString('#ff0000')->red(); // 'ff' Rgb::fromString('rgb(255, 0, 0)')->red(); // 255
green(): int|string
Return the value of the
greencolor channel.
Hex::fromString('#00ff00')->green(); // 'ff' Rgb::fromString('rgb(0, 255, 0)')->green(); // 255
blue(): int|string
Return the value of the
bluecolor channel.
Hex::fromString('#0000ff')->blue(); // 'ff' Rgb::fromString('rgb(0, 0, 255)')->blue(); // 255
toHex(): Hex
Convert a color to a
Hexcolor.
Rgb::fromString('rgb(0, 0, 255)')->toHex(); // `Hex` instance; '#0000ff'
When coming from a color format that supports opacity, the opacity will simply be omitted.
toHsl(): Hsl
Convert a color to a
Hslcolor.
Rgb::fromString('rgb(0, 0, 255)')->toHsl(); // `Hsl` instance; 'hsl(240, 100%, 50%)'
When coming from a color format that supports opacity, the opacity will simply be omitted.
Rgba::fromString('rgba(0, 0, 255, .5)')->toHsl(); // `Hsl` instance; 'hsl(240, 100%, 50%)'
toHsla(float $alpha = 1): Hsla
Convert a color to a
Hslacolor.
Rgb::fromString('rgb(0, 0, 255)')->toHsla(); // `Hsla` instance; 'hsla(240, 100%, 50%, 1.0)'
When coming from a color format that doesn't support opacity, it can be added by passing it to the
$alphaparameter.
Rgb::fromString('rgb(0, 0, 255)')->toHsla(.5); // `Hsla` instance; 'hsla(240, 100%, 50%, 0.5)'
toRgb(): Rgb
Convert a color to an
Rgbcolor.
Hex::fromString('#0000ff')->toRgb(); // `Rgb` instance; 'rgb(0, 0, 255)'
When coming from a color format that supports opacity, the opacity will simply be omitted.
Rgba::fromString('rgb(0, 0, 255, .5)')->toRgb(); // `Rgb` instance; 'rgb(0, 0, 255)'
toRgba(float $alpha = 1): Rgba
Convert a color to a
Rgbacolor.
Rgb::fromString('rgb(0, 0, 255)')->toRgba(); // `Rgba` instance; 'rgba(0, 0, 255, 1)'
When coming from a color format that doesn't support opacity, it can be added by passing it to the
$alphaparameter.
Rgba::fromString('rgb(0, 0, 255)')->toRgba(.5); // `Rgba` instance; 'rgba(0, 0, 255, .5)'
__toString(): string
Cast the color to a string.
(string) Rgb::fromString('rgb(0, 0, 255)'); // 'rgb(0,0,255)' (string) Rgba::fromString('rgb(0, 0, 255, .5)'); // 'rgb(0,0,255,0.5)' (string) Hex::fromString('#0000ff'); // '#0000ff' (string) Hsla::fromString('hsl(240, 100%, 50%)'); // 'hsl(240, 100%, 50%)' (string) Hsla::fromString('hsla(240, 100%, 50%, 1.0)'); // 'hsla(240, 100%, 50%, 1.0)'
Factory::fromString(): Color
With the
Factoryclass, you can create a color instance from any string (it does an educated guess under the hood). If the string isn't a valid color string in any format, it throws an
InvalidColorValueexception.
Factory::fromString('rgb(0, 0, 255)'); // `Rgb` instance Factory::fromString('#0000ff'); // `Hex` instance Factory::fromString('hsl(240, 100%, 50%)'); // `Hsl` instance Factory::fromString('Hello world!'); // `InvalidColorValue` exception
Please see CHANGELOG for more information what has changed recently.
$ composer test
Please see CONTRIBUTING for details.
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.
The MIT License (MIT). Please see License File for more information.