Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/elusivecodes/fyrecolor
FyreColor is a free, open-source color manipulation library for PHP.
https://github.com/elusivecodes/fyrecolor
cmy cmyk color hex hsl hsv php rgb rgba
Last synced: about 1 month ago
JSON representation
FyreColor is a free, open-source color manipulation library for PHP.
- Host: GitHub
- URL: https://github.com/elusivecodes/fyrecolor
- Owner: elusivecodes
- License: mit
- Created: 2022-05-20T11:14:40.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-29T02:02:45.000Z (6 months ago)
- Last Synced: 2024-06-30T05:09:59.611Z (6 months ago)
- Topics: cmy, cmyk, color, hex, hsl, hsv, php, rgb, rgba
- Language: PHP
- Homepage:
- Size: 106 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# FyreColor
**FyreColor** is a free, open-source immutable color manipulation library for *PHP*.
It is a modern library, and features full support for RGB, HSL, HSV, CMY and CMYK color-spaces.
## Table Of Contents
- [Installation](#installation)
- [Basic Usage](#basic-usage)
- [Color Creation](#color-creation)
- [Color Formatting](#color-formatting)
- [Color Attributes](#color-attributes)
- [Color Manipulation](#color-manipulation)
- [Color Schemes](#color-schemes)
- [Color Palettes](#color-palettes)
- [Static Methods](#static-methods)
## Installation
**Using Composer**
```
composer require fyre/color
```
In PHP:
```php
use Fyre\Color\Color;
```
## Basic Usage
**From RGB**
- `$red` is a number between *0* and *255*.
- `$green` is a number between *0* and *255*.
- `$blue` is a number between *0* and *255*.
- `$alpha` is a number between *0* and *1*, and will default to *1*.
```php
$color = new Color($red, $green, $blue, $alpha);
```
**From Brightness**
- `$brightness` is a number between *0* and *100*.
- `$alpha` is a number between *0* and *1*, and will default to *1*.
```php
$color = new Color($brightness, $alpha);
```
## Color Creation
**From String**
Create a new *Color* from a HTML color string.
- `$colorString` is a string containing a color value in either hexadecimal, RGB, RGBA, HSL, HSLA or a standard HTML color name.
```php
$color = Color::fromString($colorString);
```
**From CMY**
Create a new *Color* from CMY values.
- `$cyan` is a number between *0* and *100*.
- `$magenta` is a number between *0* and *100*.
- `$yellow` is a number between *0* and *100*.
- `$alpha` is a number between *0* and *1*, and will default to *1*.
```php
$color = Color::fromCMY($cyan, $magenta, $yellow, $alpha);
```
**From CMYK**
Create a new *Color* from CMYK values.
- `$cyan` is a number between *0* and *100*.
- `$magenta` is a number between *0* and *100*.
- `$yellow` is a number between *0* and *100*.
- `$key` is a number between *0* and *100*.
- `$alpha` is a number between *0* and *1*, and will default to *1*.
```php
$color = Color::fromCMYK($cyan, $magenta, $yellow, $key, $alpha);
```
**From HSL**
Create a new *Color* from HSL values.
- `$hue` is a number between *0* and *360*.
- `$saturation` is a number between *0* and *100*.
- `$lightness` is a number between *0* and *100*.
- `$alpha` is a number between *0* and *1*, and will default to *1*.
```php
$color = Color::fromHSL($hue, $saturation, $lightness, $alpha);
```
**From HSV**
Create a new *Color* from HSV values.
- `$hue` is a number between *0* and *360*.
- `$saturation` is a number between *0* and *100*.
- `$value` is a number between *0* and *100*.
- `$alpha` is a number between *0* and *1*, and will default to *1*.
```php
$color = Color::fromHSV($hue, $saturation, $value, $alpha);
```
## Color Formatting
**To String**
Get a HTML string representation of the color.
```php
$colorString = $color->toString();
```
The `$colorString` returned will be a string containing either a HTML color name (if one exists), a hexadecimal string (if alpha is *1*) or an RGBA string.
**To Hex String**
Get a hexadecimal string representation of the color.
```php
$hexString = $color->toHexString();
```
**To RGB String**
Get a RGB/RGBA string representation of the color.
```php
$rgbString = $color->toRGBString();
```
**To HSL String**
Get a HSL/HSLA string representation of the color.
```php
$hslString = $color->toHSLString();
```
**Label**
Get the closest color name for the color.
```php
$label = $color->label();
```
## Color Attributes
**Get Alpha**
Get the alpha value of the color (between *0* and *1*).
```php
$alpha = $color->getAlpha();
```
**Get Brightness**
Get the brightness value of the color (between *0* and *100*).
```php
$brightness = $color->getBrightness();
```
**Get Hue**
Get the hue value of the color (between *0* and *360*).
```php
$hue = $color->getHue();
```
**Get Saturation**
Get the saturation value of the color (between *0* and *100*).
```php
$saturation = $color->getSaturation();
```
**Luma**
Get the relative luminance value of the color (between *0* and *1*).
```php
$luma = $color->luma();
```
**Set Alpha**
Set the alpha value of the color.
- `$alpha` is a number between *0* and *1*.
```php
$newColor = $color->setAlpha($alpha);
```
**Set Brightness**
Set the brightness value of the color.
- `$brightness` is a number between *0* and *100*.
```php
$newColor = $color->setBrightness($brightness);
```
**Set Hue**
Set the hue value of the color.
- `$hue` is a number between *0* and *360*.
```php
$newColor = $color->setHue($hue);
```
**Set Saturation**
Set the saturation value of the color.
- `$saturation` is a number between *0* and *100*.
```php
$newColor = $color->setSaturation($saturation);
```
## Color Manipulation
**Darken**
Darken the color by a specified amount.
- `$amount` is a number between *0* and *1*.
```php
$newColor = $color->darken($amount);
```
**Invert**
Invert the color.
```php
$newColor = $color->invert();
```
**Lighten**
Lighten the color by a specified amount.
- `$amount` is a number between *0* and *1*.
```php
$newColor = $color->lighten($amount);
```
**Shade**
Shade the color by a specified amount.
- `$amount` is a number between *0* and *1*.
```php
$newColor = $color->shade($amount);
```
**Tint**
Tint the color by a specified amount.
- `$amount` is a number between *0* and *1*.
```php
$newColor = $color->tint($amount);
```
**Tone**
Tone the color by a specified amount.
- `$amount` is a number between *0* and *1*.
```php
$newColor = $color->tone($amount);
```
## Color Schemes
**Complementary**
Create a complementary color variation.
```php
$complementary = $color->complementary();
```
**Split**
Create an array with 2 split color variations.
```php
[$secondary, $accent] = $color->split();
```
**Analogous**
Create an array with 2 analogous color variations.
```php
[$secondary, $accent] = $color->analogous();
```
**Triadic**
Create an array with 2 triadic color variations.
```php
[$secondary, $accent] = $color->triadic();
```
**Tetradic**
Create an array with 3 tetradic color variations.
```php
[$secondary, $alternate, $accent] = $color->tetradic();
```
## Color Palettes
Create a palette of colors from a *Color* object you have created using the following methods.
**Shades**
Create an array with a specified number of shade variations.
- `$shades` is a number indicating how many shades you wish to generate, and will default to *10*.
```php
$colorShades = $color->shades($shades);
```
**Tints**
Create an array with a specified number of tint variations.
- `$tints` is a number indicating how many tints you wish to generate, and will default to *10*.
```php
$colorTints = $color->tints($tints);
```
**Tones**
Create an array with a specified number of tone variations.
- `$tones` is a number indicating how many tones you wish to generate, and will default to *10*.
```php
$colorTones = $color->tones($tones);
```
**Palette**
Create a palette object with a specified number of shades, tints and tone variations.
- `$shades` is a number indicating how many shades you wish to generate, and will default to *10*.
- `$tints` is a number indicating how many tints you wish to generate, and will default to *10*.
- `$tones` is a number indicating how many tones you wish to generate, and will default to *10*.
```php
$colorPalette = $color->palette($shades, $tints, $tones);
```
## Static Methods
**Contrast**
Calculate the contrast between two colors (between *1* and *21*).
- `$color1` is a *Color* object.
- `$color2` is a *Color* object.
```php
$contrast = Color::contrast($color1, $color2);
```
**Distance**
Calculate the distance between two colors.
- `$color1` is a *Color* object.
- `$color2` is a *Color* object.
```php
$distance = Color::dist($color1, $color2);
```
**Find Contrast**
Find an optimally contrasting color for another color.
- `$color1` is a *Color* object.
- `$color2` is a *Color* object, and will default to *null*.
- `$minContrast` is a number between *1* and *21* indicating the minimum valid contrast, and will default to *4.5*.
- `$stepSize` is a number between *0* and *1* indicating the amount to darken/lighten the color on each iteration, and will default to *0.01*.
```php
$contrastColor = Color::findContrast($color1, $color2, $minContrast, $stepSize);
```
If `$color2` value is *null*, `$color1` will be used instead.
This method will tint/shade `$color2` until it meets a minimum contrast threshold with `$color1`, then the new color will be returned. If no valid contrast value can be found, this method will return *null* instead.
**Mix**
Create a new *Color* by mixing two colors together by a specified amount.
- `$color1` is a *Color* object.
- `$color2` is a *Color* object.
- `$amount` is a number between *0* and *1*.
```php
$mixed = Color::mix($color1, $color2, $amount);
```
**Multiply**
Create a new *Color* by multiplying two colors together by a specified amount.
- `$color1` is a *Color* object.
- `$color2` is a *Color* object.
- `$amount` is a number between *0* and *1*.
```php
$multiplied = Color::multiply($color1, $color2, $amount);
```