🌈 A general-purpose color library for JavaScript.

README.md

Culori

A color library for JavaScript. Culori works across many color spaces to offer conversion, interpolation and color difference formulas.

It supports most color spaces and formats defined in the CSS Colors Level 4 spec:

Additional color spaces:

Culori can compute color differences based on a variety of formulas:

  • simple Euclidean distance
  • CIELAB Delta E* metric as formulated by CIE76, CMC l:c (1984), CIE94, and CIEDE2000
  • Kotsarenko/Ramos distance

Use any of them to pick from a palette the perceptually-closest colors to a given color.

Culori is inspired by Mike Bostock's D3.js and Gregor Aisch's chroma.js, from which it takes ideas and academic references.

Foreword

If you're thinking Do we really need another JavaScript color library?, I hear you. Reader, for the most part, we don't. Mike Bostock's d3-color, and Gregor Aisch's chroma.js are two excellent, robust libraries that provide most of what you need for working with colors on the web. See the Other Projects section for even more libraries you can try.

Culori — from the Romanian word for ‘colors’ — started with a curiosity in getting color spaces at a deeper level, maths and all; by the time I came out of this rabbit-hole, I had what I thought is a fairly fast, fairly comprehensive, set of tools for working with color, with an implementation that has certain advantages to boot.

The API tries to balance brevity, convenience and flexibility. These goals led to a functional-style API, where you transform plain objects representing colors through a series of functions. It's arguably not as readable as a fluent API but the lack of classes makes it more flexible and extensible (more on that later).

The alpha channel, which holds a color's opacity, is treated differently than in other libaries. We don't equate an undefined alpha with an alpha of 1. The hex string #ff0000 should eventually be interpreted as a fully-opaque red color, but at the color-manipulation level we want to maintain the distinction between #ff0000 (no explicit alpha) and #ff0000ff (explicit alpha of 1).

Getting Started

Try it online

You can use npm.runkit.com/culori as a playground to test various API methods without installing culori in your project. Observable is another great place to tinker with the library and see the results visually.

Install it as an npm package

npm version

culori is bundled as UMD and ES on npm. Install it using npm or yarn:

# using npm
npm install culori

# using yarn
yarn add culori

You can then import culori in your project:

// CJS style: import the whole library
let culori = require('culori');

// ES style: import individual methods
import { rgb } from 'culori';

Add it via the <script> tag

To import culori as a <script> tag to use in a web page, you can load it from unpkg:

<script src='https://unpkg.com/culori'></script>

API Reference

Color representation

Culori does not have a Color class. Instead, it uses plain objects to represent colors:

// A color in the RGB space
{
  mode: 'rgb',
  r: 0.1,
  g: 0.2,
  b: 1,
  alpha: 1
}

The object needs to have a mode property that identifies the color space, and values for each channel in that particular color space. See the Color Spaces section for the channels expected of each color space. Optionally, the alpha property is used for the color's alpha channel.

Basic methods

# culori.parse(string) → color or undefined <>

Parses a string and returns the corresponding color. The color will be in the matching color space, e.g. RGB for hex strings, HSL for hsl(…, …, …) strings, et cetera. If no built-in parsers can match the string, the function will return undefined.

// named colors:
culori.parse('red');
// => { r: 1, g: 0, b: 0, mode: 'rgb' }

// hex strings:
culori.parse('#ff0000');
// => { r: 1, g: 0, b: 0, mode: 'rgb' }

// HSL colors:
culori.parse('hsl(60 50% 10% / 100%)');
// => { h: 60, s: 0.5, b: 0.1, alpha: 1, mode: 'hsl' }

// Lab colors:
culori.parse('lab(100 -50 50)');
// => { l: 100, a: -50, b: 50, mode: 'lab' }

# culori.converter(mode = "rgb") → function (color or String) <>

Returns a converter: a function that can convert any color to the mode color space:

let rgb = culori.converter('rgb');
let lab = culori.converter('lab');

rgb('#f0f0f0');
// => { mode: "rgb", r: 0.4980392156862745, g: 0.4980392156862745, b: 0.4980392156862745 }

lab('#f0f0f0');
// => { mode: "lab", l: 94.79624582959184, a: 0 , b: 0 }"

Converters accept either strings (which will be parsed with culori.parse under the hood) or color objects. If the mode key is absent from the color, it's assumed to be in the converter's color space.

The available modes (color spaces) are listed below. Each color space included by default in culori has a shortcut for its converter, i.e. you can use culori.hsl instead of culori.converter('hsl').

Mode For Shortcut
cubehelix Cubehelix color space culori.cubehelix(color)
dlab DIN99o Lab color space culori.dlab(color)
dlch DIN99o LCh color space culori.dlch(color)
hsi HSI color space culori.hsi(color)
hsl HSL color space culori.hsl(color)
hsv HSV color space culori.hsv(color)
hwb HWB color space culori.hwb(color)
lab Lab color space culori.lab(color)
lch LCh color space culori.lch(color)
lrgb Linearized RGB color space culori.lrgb(color)
rgb RGB color space culori.rgb(color)
yiq YIQ color space culori.yiq(color)

# culori.formatter(format = 'rgb') → function (color) <>

Returns a formatter: a function that can transform colors to a useful string representation.

let hex = culori.formatter('hex');

hex('red'); // ⇒ "#ff0000"

Available formats:

Format Description
hex Returns the hex string for a color
rgb Returns the rgb(…) / rgba(…) string for a color

Reference: CSSOM standard serialization

# culori.displayable(color or String) <>

Some color spaces (Lab and LCh in particular) allow you to express colors that can't be displayed on-screen. This function checks whether a particular color fits inside the sRGB gamut — i.e. its r, g, and b channels are all in the interval [0, 1].

culori.displayable('red'); // ⇒ true
culori.displayable('rgb(300 255 255)'); // ⇒ false

# culori.clamp(method = 'rgb') → function (color) <>

Returns a function which you use to retreive a representation that's displayable on the screen for any color. There are two available methods to squeeze the color into the displayable sRGB gamut:

method = 'rgb' clamps the r, g, b channel values of the color's RGB representation to the interval [0, 1].

method = 'lch' converts the color to LCh and finds the largest Chroma value that's displayable for the given Lightness and Hue; if not even the achromatic version (Chroma = 0) of the LCh color is displayable, it falls back to the rgb method.

// RGB clamping
culori.clamp('rgb')('lab(50 100 100)');
// => { mode: "lab", l: 54.29173376861782, a: 80.8124553179771, b: 69.88504032350531 }

// LCh clamping
culori.clamp('lch')('lab(50 100 100)');
// =>  { mode: "lab", l:50.0000028101302, a: 63.11644430269186, b: 63.11642289997279 }

The clamped color will always be returned in the original color space.

# culori.round(n = 8) <>

Returns a rounder: a function with which to round numbers to at most n digits of precision.

let approx = culori.round(4);
approx(0.38393993);
// => 0.3839

Interpolation

# culori.interpolate(colors, mode = "rgb", interpolations) <>

Returns an interpolator in the mode color space for an array of colors: a function that accepts a value t in the interval [0, 1] and returns the interpolated color in the mode color space.

The colors in the array can be in any color space, or they can even be strings.

let grays = culori.interpolate(['#fff', '#000']);
grays(0.5); // => { mode: 'rgb', r: 0.5, g: 0.5, b: 0.5 }

By default, colors in all spaces are interpolated linearly. You can override the way specific channels are interpolated with the interpolations object, the third argument of culori.interpolate().

let custom_interpolator = culori.interpolate(['blue', 'red'], 'lch', {
	h: culori.interpolateLinear() // long-path hue interpolation
});

There are a few interpolation methods available, listed below. Depending on the channel, the numeric values can be interpreted/interpolated in various modes. The hue channel, for example, is interpolated by taking into account the shortest path around the hue circle (interpolateHue). And the interpolateAlpha mode assumes an undefined alpha is 1.

Interpolation methods

You'll use these methods when you want to override how colors get interpolated in a specific color space, or when defining the default interpolation for custom color spaces.

# culori.interpolateLinear(normalize = identity, γ = 1) <>

A linear interpolator for values in a channel. By default does not normalize the values.

# culori.interpolateSplineBasis(normalize = identity, type = "default", γ = 1) <>

A basis spline interpolator for values in a channel. The type can be one of the following:

  • default creates a basis spline that passes through the first and last values in the array.
  • closed creates a closed basis spline
  • open creates an open basis spline (not yet implemented)

# culori.interpolateSplineNatural(normalize = identity, type = "default", γ = 1) <>

A natural spline interpolator for values in a channel. The type can be one of the following:

  • default creates a natural spline
  • closed creates a closed natural spline

# culori.interpolateSplineMonotone(normalize = identity, type = "default", γ = 1) <>

A monotone spline interpolator for values in a channel. The type can be one of the following:

  • default creates a monotone spline
  • closed creates a closed monotone spline
  • open creates an open monotone spline (not yet implemented)

# culori.interpolateCosine(normalize = identity, γ = 1) <>

Interpolates the value using the cosine function, which can offer a smoother alternative to linear interpolation.

Interpolation modes

By default, channel values that need to be interpolated are not normalized in any way. However, for some channels, we need to do some normalization before we interpolate the values:

# culori.interpolateHue <>

Used for the hue channel in various color spaces, normalizes the array such that the interpolator takes into account the shortest path around the hue circle:

hsl/definition.js

export default {
	// ...
	interpolate: {
		h: interpolateLinear(interpolateHue),
		s: interpolateLinear(),
		l: interpolateLinear(),
		alpha: interpolateLinear(interpolateAlpha)
	}
	// ...
};

By default, hue channels in all color spaces will use this normalization. However, the example below interpolates colors in the HSL color space by treating hues as normal numeric values instead:

let hsl_long = culori.interpolate(['blue', 'red', 'green'], 'hsl', {
	h: culori.interpolateLinear()
});

(Notice we're not sending culori.interpolateHue to culori.interpolateLinear() as the first argument.)

# culori.interpolateAlpha <>

Used for the alpha channel in various color spaces such that undefined values are treated as 1 (full opacity) in some situations. This is the default for the alpha channel in all color spaces.

Evenly-spaced samples

# culori.samples(n = 2, γ = 1) <>

Returns an array of n equally-spaced samples from the [0, 1] range, with 0 and 1 at the ends. The function also accepts a γ (gamma) parameter which will map each value t to tγ.

culori.samples(3); // => [0, 0.5, 1]
culori.samples(5); // => [0, 0.25, 0.5, 0.75, 1]

culori.samples() with various gamma values

The samples are useful for culori.interpolate() to generate color scales:

let grays = culori.interpolate(['#fff', '#000']);
culori.samples(5).map(grays); // => five evenly-spaced colors

Should you want samples distributed along a different function, you can pair it with an easing function, a library such as bezier-easing, eases, or d3-scale:

let culori = require('culori');
let easing = require('bezier-easing');

// Bezier easing
let bezier = easing(0, 0, 1, 0.5);
culori.samples(10).map(bezier);

// easeInQuad
culori.samples(10).map(t => t * t);

Difference

These methods are concerned to finding the distance between two colors based on various formulas. Each of these formulas will return a function (colorA, colorB) that lets you measure the distance between two colors.

These are also available as a separate D3 plugin.

# culori.differenceEuclidean(mode = 'rgb', weights = [1, 1, 1, 0]) <>

Returns a Euclidean distance function in a certain color space.

You can optionally assign different weights to the channels in the color space. See, for example, the Kotsarenko/Ramos distance.

The default weights [1, 1, 1, 0] mean that the alpha, which is the fourth channel in all the color spaces culori defines, is not taken into account. Send [1, 1, 1, 1] as the weights to include it in the computation.

For the h channel in the color (in any color space that has this channel), we're using a shortest hue distance to compute the hue's contribution to the distance. In spaces such as HSL or HSV, where the range of this difference is [0, 180] — as opposed to [0, 1] for the other channels — consider adjusting the weights so that the hue contributes "equally" to the distance:

let hsl_distance = culori.differenceEuclidean('hsl', [
	1 / (180 * 180),
	1,
	1,
	0
]);

# culori.differenceCie76() <>

Computes the CIE76 ΔE*ab color difference between the colors a and b. The computation is done in the Lab color space and it is analogous to culori.differenceEuclidean('lab').

# culori.differenceCie94(kL = 1, K1 = 0.045, K2 = 0.015) <>

Computes the CIE94 ΔE*94 color difference between the colors a and b. The computation is done in the Lab color space.

# culori.differenceCiede2000(Kl = 1, Kc = 1, Kh = 1) <>

Computes the CIEDE2000 ΔE*00 color difference between the colors a and b as implemented by G. Sharma. The computation is done in the Lab color space.

Returns a CIEDE2000 Delta E* function.

# culori.differenceCmc() <>

Computes the CMC l:c (1984) ΔE*CMC color difference between the colors a and b. The computation is done in the Lab color space.

Note: ΔE*CMC is not considered a metric since it's not symmetrical, i.e. the distance from a to b is not always equal to the distance from b to a. Therefore it cannot be reliably used with culori.nearest().

# culori.differenceDin99o() <>

Computes the DIN99o ΔE*99o color difference between the colors a and b. The computation is done in the DIN99o color space.

# culori.differenceKotsarenkoRamos() <>

Computes the Kotsarenko/Ramos color difference between the colors a and b. This is a weighted Euclidean distance in the YIQ color space.

Nearest color(s)

# culori.nearest(colors, metric = differenceEuclidean(), accessor = identity) → function(color, n = 1, τ = Infinity) <>

For a given metric color difference formula, and an array of colors, returns a function with which you can find n colors nearest to color, with a maximum distance of τ.

Pass n = Infinity to get all colors in the array with a maximum distance of τ.

Extending culori

# culori.defineMode(definition) <>

Defines a new color space through a definition object. By way of example, here's the definition of the HSL color space:

{
	mode: 'hsl',
	output: {
		rgb: convertHslToRgb
	},
	input: {
		rgb: convertRgbToHsl
	},
	channels: ['h', 's', 'l', 'alpha'],
	parsers: [parseHsl],
	interpolate: {
		h: interpolateLinear(interpolateHue),
		s: interpolateLinear(),
		l: interpolateLinear(),
		alpha: interpolateLinear(interpolateAlpha)
	}
}

The properties a definition needs are the following:

  • mode: the string identifier for the color space
  • output: a set of functions to convert from the color space we're defining to other color spaces. At least rgb needs to be included; in case a specific conversion pair between two color spaces is missing, RGB is used as the "buffer" for the conversion.
  • input: opposite of output; a set of function to convert from various color spaces to the color space we're defining. At least rgb needs to be included.
  • channels: a list of channels for the color space.
  • parsers: any parsers for the color space that can transform strings into colors
  • interpolate: the default interpolations for the color space.

Note: The order of the items in the channels array matters. To keep things simple, we're making the following conventions:

  • the fourth item in the array should be alpha
  • any cyclical values (e.g. hue) should be identified by h, in the range [0, 360)

These constrains make sure differenceEuclidean() works as expected.

Color Spaces

RGB

🕳 expand this section

LRGB (Linear RGB)

🕳 expand this section

📖 See Jamie Wong's excellent deep dive into color.

HSL / HSV / HSI

HSL, HSV, and HSI are a family of representations of the RGB color space, created in 1970 to provide color spaces more closely aligned to how humans perceive colors.

💡 In this family of color spaces, the hue is undefined for achromatic colors (i.e. shades of gray).

hsl

Channel Range Description
h [0, 360) Hue
s [0, 1] Saturation in HSL
l [0, 1] Lightness

The figure below shows a slice of the HSL color space for a particular hue:

hsv

Channel Range Description
h [0, 360) Hue
s [0, 1] Saturation in HSV
v [0, 1] Value

The figure below shows a slice of the HSV color space for a particular hue:

hsi

Channel Range Description
h [0, 360) Hue
s [0, 1] Saturation in HSI
i [0, 1] Intensity

The figure below shows a slice of the HSI color space for a particular hue:

💡 While the hue in this family of color spaces retains its value in all of them, the saturation in HSL is not interchangeable with the saturation from HSV, nor HSI — they're computed differently, depending on the color space.

HWB

The HWB color space was developed by Alvy Ray Smith, who also created the HSV color space. It's meant to be more intuitive for humans to use and faster to compute.

References:

Lab / LCh (CIE)

As defined in the CSS Color Module Level 4 spec, we use the D50 illuminant as a reference white for these color spaces.

lab

Channel Range Description
l [0 — 100] Lightness
a [-79.2872, 93.55] Green–red component
b [-112.0294, 93.3884] Blue–yellow component

lch

Channel Range Description
l [0 - 100] Lightness
c [0 - 131.207] Chroma
h [0 - 360] Hue

💡 The range for the a and b channels in Lab, and the c channel in LCh, depend on the specific implementation. I've obtained the ranges from the tables above by converting all sRGB colors defined by r, g, b ∈ ℕ ⋂ [0, 255] into Lab and LCh respectively.

DIN99 Lab / LCh

The DIN99 color space "squishes" the CIE Lab color space to obtain an effective color difference metric that can be expressed as a simple Euclidean distance. We implement the latest iteration of the the standard, DIN99o.

dlab

Channel Range Description
l ? Lightness
a ?
b ?

dlch

Channel Range Description
l ? Lightness
c ? Chroma
h ? Hue

References:

YIQ

YIQ is the color space used by the NTSC color TV system. It contains the following channels:

Channel Range Description
Y [0,1] Luma
I [-0.5957, 0.5957] In-phase (orange-blue axis)
Q [-0.5226, 0.5226] Quadrature (green-purple axis)

Cubehelix

The Cubehelix color scheme was described by Dave Green in this paper:

It was expanded into a color space by Mike Bostock and Jason Davies in D3.

cubehelix

The channels in the cubehelix color space maintain the conventions from D3, namely:

Channel Range Description
h [0, 360) Hue (Based on start color and rotations as defined in Green's paper)
s [0, 4.6143] Saturation (Called hue in op. cit.)
l [0, 1] Lightness

Culori Recipes

Relative luminance of a color

The relative luminance of a color is defined as:

L = 0.2126 * R + 0.7152 * G + 0.0722 * B;

Where R, G, and B are the components from the LRGB color space.

To compute it in culori:

function luminance(color) {
	let c = culori.lrgb(color);
	return 0.2126 * c.r + 0.7152 * c.g + 0.0722 * c.b;
}

Note: The WCAG defines the luminance using a deprecated value for converting sRGB to LRGB. If you'd like a strict implementation, you'll need to write your own sRGB → LRGB conversion.

Contrast ratio

Using the luminance() function above, the contrast() ratio is simply the ratio between the luminances of two colors, with the values shifted by 0.05 to avoid division by zero when comparing against black.

function contrast(colorA, colorB) {
	let L1 = luminance(colorA);
	let L2 = luminance(colorB);
	return (L1 + 0.05) / (L2 + 0.05);
}

Related projects

These projects add more functionality to culori, but they're separate as to keep the core bundle small:

culori-scales

Color scales (ColorBrewer, matplotlib, etc).

culori-names

More named colors, from a variety of sources.

Products using culori

Moqups

All our color-manipulation functions are handled by culori.

Dainty

Dainty is a configurable refined and balanced color theme for Visual Studio using Culori’s CIELAB capabilities for generating and processing colors.

Does your product/project use culori? Create a PR and add yourself to this list!

Other projects

Some popular libraries you may want to look at are:

Please suggest more interesting projects.

Colophon