JSPM

Features

• 📦 Small: Just 1.4 KB gzipped (3+ times lighter than color and tinycolor2)
• 🚀 Fast: 2+ times faster than color and tinycolor2
• 😍 Simple: Chainable API and familiar patterns
• 💪 Immutable: No need to worry about data mutations
• 🛡 Bulletproof: Written in strict TypeScript and 100% covered by tests
• 🗂 Typed: All types are available out of the box
• 🏗 Extendable: Built-in plugin system to add new functionality
• 👫 Works everywhere: Supports all browsers and Node 12+
• 💨 Dependency-free

Benchmarks

Library	Operations/sec	Size	Size (gzip)	Dependencies	Types
colord 👑	2 274 420
color	717 048
tinycolor2	956 285
ac-colors	637 469
chroma-js	900 826

The performance results were generated on a MBP 2019, 2,6 GHz Intel Core i7 via running npm run benchmark in the library folder. See tests/benchmark.ts.

Getting Started

npm i colord

import { colord } from "colord";

colord("#ff0000").grayscale().alpha(0.25).toRgbaString(); // "rgba(128, 128, 128, 0.25)"
colord("rgb(192, 192, 192)").isLight(); // true
colord("hsl(0, 50%, 50%)").darken(0.25).toHex(); // "#602020"

API

Color parsing

Accepted input formats

• Hexadecimal strings (including 3, 4 and 8 digit notations)
• RGB(A) strings and objects
• HSL(A) strings and objects
• HSV(A) objects
• Color names (via plugin)
• XYZ objects (via plugin)
• LCH (coming soon)

// String input examples
colord("FFF");
colord("#ffffff");
colord("#ffffffff");
colord("rgb(255, 255, 255)");
colord("rgba(255, 255, 255, 1)");
colord("hsl(0, 100%, 100%)");
colord("hsla(0, 100%, 100%, 1)");

// Object input examples
colord({ r: 255, g: 255, b: 255 });
colord({ r: 255, g: 255, b: 255, a: 1 });
colord({ h: 360, s: 100, l: 100 });
colord({ h: 360, s: 100, l: 100, a: 1 });
colord({ h: 360, s: 100, v: 100 });
colord({ h: 360, s: 100, v: 100, a: 1 });

Permissive parser

The library's parser trims unnecessary whitespaces, clamps numbers, disregards character case, punctuation, brackets, etc.

colord(" aBc ").toHex(); // "#aabbcc"
colord("__rGbA 10 20,  999...").toRgbaString(); // "rgba(10, 20, 255, 1)"
colord(" hsL(  10, 200% 30 .5!!!").toHslaString(); // "hsla(10, 100%, 30%, 0.5)"

Color conversion

Color manipulation

Color analysis

Plugins

Colord has a built-in plugin system that allows new features and functionality to be easily added.

CSS color names

Provides options to convert a color into a CSS color keyword and vice versa.

import { colord, extend } from "colord";
import namesPlugin from "colord/plugins/names";

extend([namesPlugin]);

colord("tomato").toHex(); // "#ff6347"
colord("#00ffff").toName(); // "cyan"
colord("#aabbcc").toName(); // undefined (the color is not specified in CSS specs)

XYZ color space

Adds support of CIE XYZ color model. The conversion logic is ported from CSS Color Module Level 4 Specification.

import { colord, extend } from "colord";
import xyzPlugin from "colord/plugins/xyz";

extend([xyzPlugin]);

colord("#ffffff").toXyz(); // { x: 95.047, y: 100, z: 108.883, a: 1 }
colord({ x: 0, y: 0, z: 0 }).toHex(); // "#000000"

Types

While not only typing its own functions and variables, Colord can also help you type yours. Depending on the color space you are using, you can also import and use the type that is associated with it.

import { RgbColor, RgbaColor, HslColor, HslaColor, HsvColor, HsvaColor } from "colord";

const foo: HslColor = { h: 0, s: 0, l: 0 };
const bar: RgbColor = { r: 0, g: 0, v: 0 }; // ERROR

Roadmap

• Parse and convert Hex, RGB(A), HSL(A), HSV(A)
• Saturate, desaturate, grayscale
• Trim an input value
• Clamp input numbers to resolve edge cases (e.g. rgb(256, -1, 999, 2))
• brightness, isDark, isLight
• Set and get alpha
• Plugin API
• 4 and 8 digit Hex
• lighten, darken
• invert
• CSS color names (via plugin)
• Mix colors (via plugin)
• A11y and contrast utils (via plugin)
• CMYK color space (via plugin)
• 🚧 XYZ color space (via plugin)
• LAB color space (via plugin)
• LCH color space (via plugin)