PHPackages                             tinycolor/tinycolor - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. tinycolor/tinycolor

ActiveLibrary[Utility & Helpers](/categories/utility)

tinycolor/tinycolor
===================

a library for color manipulation and conversion in PHP

v1.0.0(6y ago)717.8k↑250%15[1 PRs](https://github.com/ScoLib/tinycolor-php/pulls)MITPHPPHP ~7.2

Since Mar 24Pushed 1y ago2 watchersCompare

[ Source](https://github.com/ScoLib/tinycolor-php)[ Packagist](https://packagist.org/packages/tinycolor/tinycolor)[ Docs](https://github.com/scolib/tinycolor-php)[ RSS](/packages/tinycolor-tinycolor/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (1)Dependencies (2)Versions (2)Used By (0)

TinyColor-PHP
=============

[](#tinycolor-php)

[![Latest Version on Packagist](https://camo.githubusercontent.com/365c0a0f2e7feea117169e58d44630c5f3f53b9d628dbbb52dce4a46b9191011/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f74696e79636f6c6f722f74696e79636f6c6f722e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/tinycolor/tinycolor)[![Software License](https://camo.githubusercontent.com/55c0218c8f8009f06ad4ddae837ddd05301481fcf0dff8e0ed9dadda8780713e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265)](LICENSE.md)[![Build Status](https://camo.githubusercontent.com/e6cf7e426884b32d02cffa27b2b8b9c3583201295066ddac356ce0239baccde9/68747470733a2f2f696d672e736869656c64732e696f2f7472617669732f73636f6c69622f74696e79636f6c6f722d7068702f6d61737465722e7376673f7374796c653d666c61742d737175617265)](https://travis-ci.com/scolib/tinycolor-php)[![Total Downloads](https://camo.githubusercontent.com/dbf9d227b14c07dfd6664cbbf22832b3587fa3921be283a90ff2b967759dbccb/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f74696e79636f6c6f722f74696e79636f6c6f722e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/tinycolor/tinycolor)

TinyColor-PHP is a [TinyColor](https://github.com/bgrins/TinyColor) implementation written in PHP

Install
-------

[](#install)

Via Composer

```
$ composer require tinycolor/tinycolor
```

Usage
-----

[](#usage)

Call `tinycolor(input)` or `\TinyColor\TinyColor::parse(input)`, and you will have an object with the following properties. See Accepted String Input and Accepted Array Input below for more information about what is accepted.

Accepted String Input
---------------------

[](#accepted-string-input)

The string parsing is very permissive. It is meant to make typing a color as input as easy as possible. All commas, percentages, parenthesis are optional, and most input allow either 0-1, 0%-100%, or 0-n (where n is either 100, 255, or 360 depending on the value).

HSL and HSV both require either 0%-100% or 0-1 for the `S`/`L`/`V` properties. The `H` (hue) can have values between 0%-100% or 0-360.

RGB input requires either 0-255 or 0%-100%.

If you call `\TinyColor\TinyColor::fromRatio`, RGB and Hue input can also accept 0-1.

Here are some examples of string input:

### Hex, 8-digit (RGBA) Hex

[](#hex-8-digit-rgba-hex)

```
tinycolor("#000");
tinycolor("000");
tinycolor("#369C");
tinycolor("369C");
tinycolor("#f0f0f6");
tinycolor("f0f0f6");
tinycolor("#f0f0f688");
tinycolor("f0f0f688");
```

### RGB, RGBA

[](#rgb-rgba)

```
tinycolor("rgb (255, 0, 0)");
tinycolor("rgb 255 0 0");
tinycolor("rgba (255, 0, 0, .5)");
tinycolor(['r' => 255, 'g' => 0, 'b' => 0]);
\TinyColor\TinyColor::fromRatio(['r' => 1, 'g' => 0, 'b' => 0]);
\TinyColor\TinyColor::fromRatio(['r' => '.5', 'g' => '.5', 'b' => '.5']);
```

### HSL, HSLA

[](#hsl-hsla)

```
tinycolor("hsl(0, 100%, 50%)");
tinycolor("hsla(0, 100%, 50%, .5)");
tinycolor("hsl(0, 100%, 50%)");
tinycolor("hsl 0 1.0 0.5");
tinycolor(['h' => 0, 's' => 1, 'l' => .5]);
\TinyColor\TinyColor::fromRatio(['h' => 1, 's' => 0, 'l' => 0]);
\TinyColor\TinyColor::fromRatio(['h' => .5, 's' => .5, 'l' => .5]);
```

### HSV, HSVA

[](#hsv-hsva)

```
tinycolor("hsv(0, 100%, 100%)");
tinycolor("hsva(0, 100%, 100%, .5)");
tinycolor("hsv (0 100% 100%)");
tinycolor("hsv 0 1 1");
tinycolor(['h' => 0, 's' => 100, 'v' => 100]);
\TinyColor\TinyColor::fromRatio(['h' => 1, 's' => 0, 'v' => 0]);
\TinyColor\TinyColor::fromRatio(['h' => .5, 's' => .5, 'v' => .5]);
```

### Named

[](#named)

```
tinycolor("RED");
tinycolor("blanchedalmond");
tinycolor("darkblue");
```

### Accepted Array Input

[](#accepted-array-input)

If you are calling this from code, you may want to use array input. Here are some examples of the different types of accepted array inputs:

```
['r' => 255, 'g' => 0, 'b' => 0]
['r' => 255, 'g' => 0, 'b' => 0, 'a' => .5]
['h' => 0, 's' => 100, 'l' => 50]
['h' => 0, 's' => 100, 'v' => 100]

```

Methods
-------

[](#methods)

### getFormat

[](#getformat)

Returns the format used to create the tinycolor instance

```
$color = tinycolor("red");
$color->getFormat(); // "name"
$color = tinycolor(['r' => 255, 'g' => 255, 'b' => 255]);
$color->getFormat(); // "rgb"
```

### getOriginalInput

[](#getoriginalinput)

Returns the input passed into the constructer used to create the tinycolor instance

```
$color = tinycolor("red");
$color->getOriginalInput(); // "red"
$color = tinycolor(['r' => 255, 'g' => 255, 'b' => 255]);
$color->getOriginalInput(); // "['r' => 255, 'g' => 255, 'b' => 255]"
```

### isValid

[](#isvalid)

Return a boolean indicating whether the color was successfully parsed. Note: if the color is not valid then it will act like `black` when being used with other methods.

```
$color1 = tinycolor("red");
$color1->isValid(); // true
$color1->toHexString(); // "#ff0000"

$color2 = tinycolor("not a color");
$color2->isValid(); // false
$color2->toString(); // "#000000"
```

### getBrightness

[](#getbrightness)

Returns the perceived brightness of a color, from `0-255`, as defined by [Web Content Accessibility Guidelines (Version 1.0)](http://www.w3.org/TR/AERT#color-contrast).

```
$color1 = tinycolor("#fff");
$color1->getBrightness(); // 255

$color2 = tinycolor("#000");
$color2->getBrightness(); // 0
```

### isLight

[](#islight)

Return a boolean indicating whether the color's perceived brightness is light.

```
$color1 = tinycolor("#fff");
$color1->isLight(); // true

$color2 = tinycolor("#000");
$color2->isLight(); // false
```

### isDark

[](#isdark)

Return a boolean indicating whether the color's perceived brightness is dark.

```
$color1 = tinycolor("#fff");
$color1->isDark(); // false

$color2 = tinycolor("#000");
$color2->isDark(); // true
```

### getLuminance

[](#getluminance)

Returns the perceived luminance of a color, from `0-1` as defined by [Web Content Accessibility Guidelines (Version 2.0).](http://www.w3.org/TR/2008/REC-WCAG20-20081211/#contrast-ratiodef)

```
$color1 = tinycolor("#fff");
$color1->getLuminance(); // 1

$color2 = tinycolor("#000");
$color2->getLuminance(); // 0
```

### getAlpha

[](#getalpha)

Returns the alpha value of a color, from `0-1`.

```
$color1 = tinycolor("rgba(255, 0, 0, .5)");
$color1->getAlpha(); // 0.5

$color2 = tinycolor("rgb(255, 0, 0)");
$color2->getAlpha(); // 1

$color3 = tinycolor("transparent");
$color3->getAlpha(); // 0
```

### setAlpha

[](#setalpha)

Sets the alpha value on a current color. Accepted range is in between `0-1`.

```
$color = tinycolor("red");
$color->getAlpha(); // 1
$color->setAlpha(.5);
$color->getAlpha(); // .5
$color->toRgbString(); // "rgba(255, 0, 0, .5)"
```

### String Representations

[](#string-representations)

The following methods will return a property for the `alpha` value, which can be ignored: `toHsv`, `toHsl`, `toRgb`

### toHsv

[](#tohsv)

```
$color = tinycolor("red");
$color->toHsv(); // ['h' => 0, 's' => 1, 'v' => 1, 'a' => 1]
```

### toHsvString

[](#tohsvstring)

```
$color = tinycolor("red");
$color->toHsvString(); // "hsv(0, 100%, 100%)"
$color->setAlpha(0.5);
$color->toHsvString(); // "hsva(0, 100%, 100%, 0.5)"
```

### toHsl

[](#tohsl)

```
$color = tinycolor("red");
$color->toHsl(); // ['h' => 0, 's' => 1, 'l' => 0.5, 'a' => 1]
```

### toHslString

[](#tohslstring)

```
$color = tinycolor("red");
$color->toHslString(); // "hsl(0, 100%, 50%)"
$color->setAlpha(0.5);
$color->toHslString(); // "hsla(0, 100%, 50%, 0.5)"
```

### toHex

[](#tohex)

```
$color = tinycolor("red");
$color->toHex(); // "ff0000"
```

### toHexString

[](#tohexstring)

```
$color = tinycolor("red");
$color->toHexString(); // "#ff0000"
```

### toHex8

[](#tohex8)

```
$color = tinycolor("red");
$color->toHex8(); // "ff0000ff"
```

### toHex8String

[](#tohex8string)

```
$color = tinycolor("red");
$color->toHex8String(); // "#ff0000ff"
```

### toRgb

[](#torgb)

```
$color = tinycolor("red");
$color->toRgb(); // { r: 255, g: 0, b: 0, a: 1 }
```

### toRgbString

[](#torgbstring)

```
$color = tinycolor("red");
$color->toRgbString(); // "rgb(255, 0, 0)"
$color->setAlpha(0.5);
$color->toRgbString(); // "rgba(255, 0, 0, 0.5)"
```

### toPercentageRgb

[](#topercentagergb)

```
$color = tinycolor("red");
$color->toPercentageRgb(); // ['r' => "100%", 'g' => "0%", 'b' => "0%", 'a' => 1]
```

### toPercentageRgbString

[](#topercentagergbstring)

```
$color = tinycolor("red");
$color->toPercentageRgbString(); // "rgb(100%, 0%, 0%)"
$color->setAlpha(0.5);
$color->toPercentageRgbString(); // "rgba(100%, 0%, 0%, 0.5)"
```

### toName

[](#toname)

```
$color = tinycolor("red");
$color->toName(); // "red"
```

### toFilter

[](#tofilter)

```
$color = tinycolor("red");
$color->toFilter(); // "progid:DXImageTransform.Microsoft.gradient(startColorstr=#ffff0000,endColorstr=#ffff0000)"
```

### toString

[](#tostring)

Print to a string, depending on the input format. You can also override this by passing one of `"rgb", "prgb", "hex6", "hex3", "hex8", "name", "hsl", "hsv"` into the function.

```
$color1 = tinycolor("red");
$color1->toString(); // "red"
$color1->toString("hsv"); // "hsv(0, 100%, 100%)"

$color2 = tinycolor("rgb(255, 0, 0)");
$color2->toString(); // "rgb(255, 0, 0)"
$color2->setAlpha(.5);
$color2->toString(); // "rgba(255, 0, 0, 0.5)"
```

### Color Modification

[](#color-modification)

These methods manipulate the current color, and return it for chaining. For instance:

```
tinycolor("red")->lighten()->desaturate()->toHexString(); // "#f53d3d"
```

### lighten

[](#lighten)

`lighten: function($amount = 10) -> TinyColor\Color`. Lighten the color a given amount, from 0 to 100. Providing 100 will always return white.

```
tinycolor("#f00")->lighten()->toString(); // "#ff3333"
tinycolor("#f00")->lighten(100)->toString(); // "#ffffff"
```

### brighten

[](#brighten)

`brighten: function($amount = 10) -> TinyColor\Color`. Brighten the color a given amount, from 0 to 100.

```
tinycolor("#f00")->brighten()->toString(); // "#ff1919"
```

### darken

[](#darken)

`darken: function($amount = 10) -> TinyColor\Color`. Darken the color a given amount, from 0 to 100. Providing 100 will always return black.

```
tinycolor("#f00")->darken()->toString(); // "#cc0000"
tinycolor("#f00")->darken(100)->toString(); // "#000000"
```

### desaturate

[](#desaturate)

`desaturate: function($amount = 10) -> TinyColor\Color`. Desaturate the color a given amount, from 0 to 100. Providing 100 will is the same as calling `greyscale`.

```
tinycolor("#f00")->desaturate()->toString(); // "#f20d0d"
tinycolor("#f00")->desaturate(100)->toString(); // "#808080"
```

### saturate

[](#saturate)

`saturate: function($amount = 10) -> TinyColor\Color`. Saturate the color a given amount, from 0 to 100.

```
tinycolor("hsl(0, 10%, 50%)")->saturate()->toString(); // "hsl(0, 20%, 50%)"
```

### greyscale

[](#greyscale)

`greyscale: function() -> TinyColor\Color`. Completely desaturates a color into greyscale. Same as calling `desaturate(100)`.

```
tinycolor("#f00")->greyscale()->toString(); // "#808080"
```

### spin

[](#spin)

`spin: function($amount = 0) -> TinyColor\Color`. Spin the hue a given amount, from -360 to 360. Calling with 0, 360, or -360 will do nothing (since it sets the hue back to what it was before).

```
tinycolor("#f00")->spin(180)->toString(); // "#00ffff"
tinycolor("#f00")->spin(-90)->toString(); // "#7f00ff"
tinycolor("#f00")->spin(90)->toString(); // "#80ff00"

// spin(0) and spin(360) do nothing
tinycolor("#f00")->spin(0)->toString(); // "#ff0000"
tinycolor("#f00")->spin(360)->toString(); // "#ff0000"
```

### Color Combinations

[](#color-combinations)

Combination functions return an array of TinyColor objects unless otherwise noted.

### analogous

[](#analogous)

`analogous: function($results = 6, $slices = 30) -> array`.

```
$colors = tinycolor("#f00")->analogous();
array_map(function ($t) { return $t->toHexString();}, $colors); // [ "#ff0000", "#ff0066", "#ff0033", "#ff0000", "#ff3300", "#ff6600" ]
```

### monochromatic

[](#monochromatic)

`monochromatic: function($results = 6) -> array`.

```
$colors = tinycolor("#f00").monochromatic();
array_map(function ($t) { return $t->toHexString();}, $colors); // [ "#ff0000", "#2a0000", "#550000", "#800000", "#aa0000", "#d40000" ]
```

### splitcomplement

[](#splitcomplement)

`splitcomplement: function() -> array`.

```
$colors = tinycolor("#f00").splitcomplement();
array_map(function ($t) { return $t->toHexString();}, $colors); // [ "#ff0000", "#ccff00", "#0066ff" ]
```

### triad

[](#triad)

`triad: function() -> array`.

```
$colors = tinycolor("#f00")->triad();
array_map(function ($t) { return $t->toHexString();}, $colors); // [ "#ff0000", "#00ff00", "#0000ff" ]
```

### tetrad

[](#tetrad)

`tetrad: function() -> array`.

```
$colors = tinycolor("#f00")->tetrad();
array_map(function ($t) { return $t->toHexString();}, $colors); // [ "#ff0000", "#80ff00", "#00ffff", "#7f00ff" ]
```

### complement

[](#complement)

`complement: function() -> TinyColor\Color`.

```
tinycolor("#f00")->complement()->toHexString(); // "#00ffff"
```

Color Utilities
---------------

[](#color-utilities)

```
\TinyColor\TinyColor::equals($color1, $color2);
\TinyColor\TinyColor::mix($color1, $color2, $amount);
```

### random

[](#random)

Returns a random color.

```
$color = \TinyColor\TinyColor::random();
$color->toRgb(); // "['r' => 145, 'g' => 40, 'b' => 198, 'a' => 1]"
```

### Readability

[](#readability)

TinyColor assesses readability based on the [Web Content Accessibility Guidelines (Version 2.0)](http://www.w3.org/TR/2008/REC-WCAG20-20081211/#contrast-ratiodef).

#### readability

[](#readability-1)

`readability: function(TinyColor\Color, TinyColor\Color) -> Number`. Returns the contrast ratio between two colors.

```
\TinyColor\TinyColor::readability("#000", "#000"); // 1
\TinyColor\TinyColor::readability("#000", "#111"); // 1.1121078324840545
\TinyColor\TinyColor::readability("#000", "#fff"); // 21
```

Use the values in your own calculations, or use one of the convenience functions below.

#### isReadable

[](#isreadable)

`isReadable: function(TinyColor\Color, TinyColor\Color, Array) -> Boolean`. Ensure that foreground and background color combinations meet WCAG guidelines. `Array` is optional, defaulting to `['level' => "AA",'size' => "small"]`. `level` can be `"AA"` or "AAA" and `size` can be `"small"` or `"large"`.

Here are links to read more about the [AA](http://www.w3.org/TR/UNDERSTANDING-WCAG20/visual-audio-contrast-contrast.html) and [AAA](http://www.w3.org/TR/UNDERSTANDING-WCAG20/visual-audio-contrast7.html) requirements.

```
\TinyColor\TinyColor::isReadable("#000", "#111", []); // false
\TinyColor\TinyColor::isReadable("#ff0088", "#5c1a72",['level' => "AA",'size' => "small"]); //false
\TinyColor\TinyColor::isReadable("#ff0088", "#5c1a72",['level' => "AA",'size' => "large"]); //true
```

#### mostReadable

[](#mostreadable)

`mostReadable: function(TinyColor\Color, [TinyColor\Color, Tinycolor\Color ...], Array) -> Boolean`. Given a base color and a list of possible foreground or background colors for that base, returns the most readable color. If none of the colors in the list is readable, `mostReadable` will return the better of black or white if `includeFallbackColors:true`.

```
\TinyColor\TinyColor::mostReadable("#000", ["#f00", "#0f0", "#00f"])->toHexString(); // "#00ff00"
\TinyColor\TinyColor::mostReadable("#123", ["#124", "#125"],['includeFallbackColors' => false])->toHexString(); // "#112255"
\TinyColor\TinyColor::mostReadable("#123", ["#124", "#125"],['includeFallbackColors' => true])->toHexString();  // "#ffffff"
\TinyColor\TinyColor::mostReadable("#ff0088", ["#2e0c3a"],['includeFallbackColors' => true,'level' => "AAA",'size' => "large"])->toHexString();   // "#2e0c3a",
\TinyColor\TinyColor::mostReadable("#ff0088", ["#2e0c3a"],['includeFallbackColors' => true,'level' => "AAA",'size' => "small"])->toHexString();   // "#000000",
```

Common operations
-----------------

[](#common-operations)

### clone

[](#clone)

`clone: function() -> TinyColor\Color`. Instantiate a new TinyColor object with the same color. Any changes to the new one won't affect the old one.

```
$color1 = tinycolor("#F00");
$color2 = $color1->clone();
$color2->setAlpha(.5);

$color1->toString(); // "#ff0000"
$color2->toString(); // "rgba(255, 0, 0, 0.5)"
```

License
-------

[](#license)

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

###  Health Score

34

—

LowBetter than 77% of packages

Maintenance27

Infrequent updates — may be unmaintained

Popularity34

Limited adoption so far

Community12

Small or concentrated contributor base

Maturity51

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

2247d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/b6a8a8c087979593079b77f376d3b33bf3b0669dc9273370753772bfd88207e8?d=identicon)[klgd](/maintainers/klgd)

---

Top Contributors

[![klgd](https://avatars.githubusercontent.com/u/8554422?v=4)](https://github.com/klgd "klgd (15 commits)")

---

Tags

ScoLibtinycolor

###  Code Quality

TestsPHPUnit

Code StylePHP\_CodeSniffer

### Embed Badge

![Health badge](/badges/tinycolor-tinycolor/health.svg)

```
[![Health](https://phpackages.com/badges/tinycolor-tinycolor/health.svg)](https://phpackages.com/packages/tinycolor-tinycolor)
```

###  Alternatives

[scolib/bankcard

根据银行卡号识别所属银行以及卡类型

171.3k1](/packages/scolib-bankcard)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)