TinyColor is a small, fast library for color manipulation and conversion in JavaScript. It allows many forms of input, while providing color conversions and other color utility functions. It has no dependencies.
Including in node
tinycolor can be installed from npm:
npm install tinycolor2
Then it can be used in your script like so:
var tinycolor = require("tinycolor2");var color = tinycolor("red");
Or in a module like so:
import tinycolor from "tinycolor2";var color = tinycolor("red");
Including in a browser
The package can be bundled from npm, but if you prefer to download it locally you have two choices:
<script type='module'>import tinycolor from "https://esm.sh/tinycolor2";var color = tinycolor("red");</script>
UMD
You can use it directly in a script tag by downloading the UMD file from npm/cjs/tinycolor.js:
<script type='text/javascript' src='tinycolor.js'></script><script type='text/javascript'>var color = tinycolor("red");</script>
Usage
Call tinycolor(input) or new tinycolor(input), and you will have an object with the following properties. See Accepted String Input and Accepted Object Input below for more information about what is accepted.
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.fromRatio, RGB and Hue input can also accept 0-1.
Returns the format used to create the tinycolor instance
var color = tinycolor("red");color.getFormat(); // "name"color = tinycolor({r:255, g:255, b:255});color.getFormat(); // "rgb"
getOriginalInput
Returns the input passed into the constructor used to create the tinycolor instance
var color = tinycolor("red");color.getOriginalInput(); // "red"color = tinycolor({r:255, g:255, b:255});color.getOriginalInput(); // "{r: 255, g: 255, b: 255}"
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.
var color1 = tinycolor("red");color1.isValid(); // truecolor1.toHexString(); // "#ff0000"var color2 = tinycolor("not a color");color2.isValid(); // falsecolor2.toString(); // "#000000"
Sets the alpha value on a current color. Accepted range is in between 0-1.
var color = tinycolor("red");color.getAlpha(); // 1color.setAlpha(.5);color.getAlpha(); // .5color.toRgbString(); // "rgba(255, 0, 0, .5)"
String Representations
The following methods will return a property for the alpha value, which can be ignored: toHsv, toHsl, toRgb
toHsv
var color = tinycolor("red");color.toHsv(); // { h: 0, s: 1, v: 1, a: 1 }
toHsvString
var color = tinycolor("red");color.toHsvString(); // "hsv(0, 100%, 100%)"color.setAlpha(0.5);color.toHsvString(); // "hsva(0, 100%, 100%, 0.5)"
toHsl
var color = tinycolor("red");color.toHsl(); // { h: 0, s: 1, l: 0.5, a: 1 }
toHslString
var color = tinycolor("red");color.toHslString(); // "hsl(0, 100%, 50%)"color.setAlpha(0.5);color.toHslString(); // "hsla(0, 100%, 50%, 0.5)"
toHex
var color = tinycolor("red");color.toHex(); // "ff0000"
toHexString
var color = tinycolor("red");color.toHexString(); // "#ff0000"
toHex8
var color = tinycolor("red");color.toHex8(); // "ff0000ff"
toHex8String
var color = tinycolor("red");color.toHex8String(); // "#ff0000ff"
toRgb
var color = tinycolor("red");color.toRgb(); // { r: 255, g: 0, b: 0, a: 1 }
toRgbString
var color = tinycolor("red");color.toRgbString(); // "rgb(255, 0, 0)"color.setAlpha(0.5);color.toRgbString(); // "rgba(255, 0, 0, 0.5)"
toPercentageRgb
var color = tinycolor("red");color.toPercentageRgb() // { r: "100%", g: "0%", b: "0%", a: 1 }
toPercentageRgbString
var color = tinycolor("red");color.toPercentageRgbString(); // "rgb(100%, 0%, 0%)"color.setAlpha(0.5);color.toPercentageRgbString(); // "rgba(100%, 0%, 0%, 0.5)"
toName
var color = tinycolor("red");color.toName(); // "red"
toFilter
var color = tinycolor("red");color.toFilter(); // "progid:DXImageTransform.Microsoft.gradient(startColorstr=#ffff0000,endColorstr=#ffff0000)"
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.
desaturate: function(amount = 10) -> TinyColor. Desaturate the color a given amount, from 0 to 100. Providing 100 will is the same as calling greyscale.
spin: function(amount = 0) -> TinyColor. 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 nothingtinycolor("#f00").spin(0).toString(); // "#ff0000"tinycolor("#f00").spin(360).toString(); // "#ff0000"
Color Combinations
Combination functions return an array of TinyColor objects unless otherwise noted.
Use the values in your own calculations, or use one of the convenience functions below.
isReadable
isReadable: function(TinyColor, TinyColor, Object) -> Boolean. Ensure that foreground and background color combinations meet WCAG guidelines. Object 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 and AAA requirements.
mostReadable: function(TinyColor, [TinyColor, Tinycolor ...], Object) -> 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.