spatie/color

The library uses a separate class for each color format, all of which implement the Spatie\Color\Color interface. This allows you to work with different color models (like RGB, Hex, or HSL) using a consistent set of methods.

Supported color classes:

• Argb
• CIELab
• Cmyk
• Hex
• Hsb
• Hsl
• Hsla
• Named
• Rgb
• Rgba
• Xyz

Install the package using Composer to handle color conversions and comparisons in your PHP project. Requires PHP 8.2 or higher.

composer require spatie/color

Use the red(), green(), and blue() methods to retrieve the values of individual color channels. The return type depends on the color format (e.g., int for Rgb or string for Hex).

Hex::fromString('#ff0000')->red(); // 'ff'
Rgb::fromString('rgb(255, 0, 0)')->red(); // 255

Every color class provides methods to convert to other formats. If converting from a format that lacks an alpha channel (like Rgb), you can provide an $alpha parameter to add opacity.

Common conversions:

• toHex(): Returns a Hex instance.
• toRgb(): Returns an Rgb instance (omits opacity if source has it).
• toRgba(float $alpha = 1): Returns a Rgba instance.
• toHsla(float $alpha = 1): Returns a Hsla instance.
• toCmyk(): Returns a Cmyk instance.
• toHsb(): Returns a Hsb instance.
• toHsl(): Returns a Hsl instance.
• toArgb(float $alpha = 1): Returns an Argb instance.
• toCIELab(): Returns a CIELab instance.
• toXyz(): Returns an Xyz instance.

// Adding alpha during conversion
Rgb::fromString('rgb(0, 0, 255)')->toHsla(.5);
// Converting and omitting existing alpha
Rgba::fromString('rgba(0, 0, 255, .5)')->toHsl();

The Xyz::fromString(string $string): static method allows you to create an Xyz instance from a formatted string. The expected format is xyz(x, y, z), where x, y, and z are numeric values separated by commas.

Example format: xyz(0.5, 0.5, 0.5)

use Spatie\Color\Xyz;

$xyz = Xyz::fromString('xyz(0.95, 1.0, 1.08)');

The Hsb class implements __toString(), which returns a string representation in the format hsb(hue,saturation%,brightness%). The hue, saturation, and brightness values are rounded in the output string.

$color = new Hsb(120.4, 100.1, 50.9);
echo (string) $color; // "hsb(120,100%,51%)"

You can retrieve the individual components of an Hsb instance:

• hue(): float - Returns the hue.
• saturation(): float - Returns the saturation.
• brightness(): float - Returns the brightness.
• red(): int - Returns the red component (0-255).
• green(): int - Returns the green component (0-255).
• blue(): int - Returns the blue component (0-255).

$color = new Hsb(180, 50, 50);

echo $color->hue();        // 180
echo $color->red();       // RGB red component

You can create an Rgba instance by passing the red, green, and blue integer values (0-255) and a float alpha value (0.0-1.0) to the constructor. Alternatively, use the fromString() static method to create an instance from a CSS-style rgba() string.

use Spatie\
Color\\Rgba;

// Via constructor
$rgba = new Rgba(255, 0, 0, 0.5);

// Via CSS string
$rgba = Rgba::fromString('rgba(255, 0, 0, 0.5)');

Use the following methods to retrieve the individual color components of an Rgba instance:

• red(): Returns the red channel as an int.
• green(): Returns the green channel as an int.
• blue(): Returns the blue channel as an int.
• alpha(): Returns the alpha channel as a float.

$red = $rgba->red();
$green = $rgba->green();
$blue = $rgba->blue();
$alpha = $rgba->alpha();