Have ideas to improve npm?Join in the discussion! Β»

    colord
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.1Β β€’Β PublicΒ β€’Β Published
    Colord is a tiny yet powerful tool for high-performance color manipulations and conversions.

    Features

    • πŸ“¦ Small: Just 1.6 KB gzipped (3x+ lighter than color and tinycolor2)
    • πŸš€ Fast: 3x+ 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 has 100% test coverage
    • πŸ—‚ Typed: Ships with types included
    • πŸ— Extendable: Built-in plugin system to add new functionality
    • πŸ“š CSS-compliant: Strictly follows CSS Color Level specifications
    • πŸ‘« Works everywhere: Supports all browsers and Node.js
    • πŸ’¨ Dependency-free
    ---

    Benchmarks

    Library Operations/sec Size
    (minified)
    Size
    (gzipped)
    Dependencies Type declarations
    colord πŸ‘‘ 3,524,989
    color 744,263
    tinycolor2 971,312
    ac-colors 660,722
    chroma-js 962,967

    The performance results were generated on a MBP 2019, 2,6 GHz Intel Core i7 by 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).toRgbString(); // "rgba(128, 128, 128, 0.25)"
    colord("rgb(192, 192, 192)").isLight(); // true
    colord("hsl(0, 50%, 50%)").darken(0.25).toHex(); // "#602020"
    ---

    Supported Color Models

    • Hexadecimal strings (including 3, 4 and 8 digit notations)
    • RGB strings and objects
    • HSL strings and objects
    • HSV objects
    • Color names (via plugin)
    • HWB objects and strings (via plugin)
    • LCH objects and strings (via plugin)
    • LAB objects (via plugin)
    • XYZ objects (via plugin)
    ---

    API

    Color parsing

    colord(input)

    Parses the given input and creates a new Colord instance. String parsing strictly conforms to CSS Color Level Specifications.

    import { colord } from "colord";
    
    // String input examples
    colord("#FFF");
    colord("#ffffff");
    colord("#ffffffff");
    colord("rgb(255, 255, 255)");
    colord("rgba(255, 255, 255, 0.5)");
    colord("rgba(100% 100% 100% / 50%)");
    colord("hsl(90, 100%, 100%)");
    colord("hsla(90, 100%, 100%, 0.5)");
    colord("hsla(90deg 100% 100% / 50%)");
    colord("tomato"); // requires "names" plugin
    
    // 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 });

    Check out the "Plugins" section for more input format examples.

    getFormat(input)

    Returns a color model name for the input passed to the function. Uses the same parsing system as colord function.

    import { getFormat } from "colord";
    
    getFormat("#aabbcc"); // "hex"
    getFormat({ r: 13, g: 237, b: 162, a: 0.5 }); // "rgb"
    getFormat("hsl(180deg, 50%, 50%)"); // "hsl"
    getFormat("WUT?"); // undefined

    Color conversion

    .toHex()

    Returns the hexadecimal representation of a color. When the alpha channel value of the color is less than 1, it outputs #rrggbbaa format instead of #rrggbb.

    colord("rgb(0, 255, 0)").toHex(); // "#00ff00"
    colord({ h: 300, s: 100, l: 50 }).toHex(); // "#ff00ff"
    colord({ r: 255, g: 255, b: 255, a: 0 }).toHex(); // "#ffffff00"
    .toRgb()
    colord("#ff0000").toRgb(); // { r: 255, g: 0, b: 0, a: 1 }
    colord({ h: 180, s: 100, l: 50, a: 0.5 }).toRgb(); // { r: 0, g: 255, b: 255, a: 0.5 }
    .toRgbString()
    colord("#ff0000").toRgbString(); // "rgb(255, 0, 0)"
    colord({ h: 180, s: 100, l: 50, a: 0.5 }).toRgbString(); // "rgba(0, 255, 255, 0.5)"
    .toHsl()

    Converts a color to HSL color space and returns an object.

    colord("#ffff00").toHsl(); // { h: 60, s: 100, l: 50, a: 1 }
    colord("rgba(0, 0, 255, 0.5) ").toHsl(); // { h: 240, s: 100, l: 50, a: 0.5 }
    .toHslString()

    Converts a color to HSL color space and expresses it through the functional notation.

    colord("#ffff00").toHslString(); // "hsl(60, 100%, 50%)"
    colord("rgba(0, 0, 255, 0.5)").toHslString(); // "hsla(240, 100%, 50%, 0.5)"
    .toHsv()

    Converts a color to HSV color space and returns an object.

    colord("#ffff00").toHsv(); // { h: 60, s: 100, v: 100, a: 1 }
    colord("rgba(0, 255, 255, 0.5) ").toHsv(); // { h: 180, s: 100, v: 100, a: 1 }
    .toName() (names plugin)

    Converts a color to a CSS keyword. Returns undefined if the color is not specified in the specs.

    import { colord, extend } from "colord";
    import namesPlugin from "colord/plugins/names";
    
    extend([namesPlugin]);
    
    colord("#ff6347").toName(); // "tomato"
    colord("#00ffff").toName(); // "cyan"
    colord("#aabbcc").toName(); // undefined (the color is not specified in CSS specs)
    colord("rgba(0, 0, 0, 0)").toName(); // "transparent"
    .toHwb() (hwb plugin)

    Converts a color to HWB (Hue-Whiteness-Blackness) color space.

    import { colord, extend } from "colord";
    import hwbPlugin from "colord/plugins/hwb";
    
    extend([hwbPlugin]);
    
    colord("#ffffff").toHwb(); // { h: 0, w: 100, b: 0, a: 1 }
    colord("#555aaa").toHwb(); // { h: 236, w: 33, b: 33, a: 1 }
    .toHwbString() (hwb plugin)

    Converts a color to HWB (Hue-Whiteness-Blackness) color space and expresses it through the functional notation.

    import { colord, extend } from "colord";
    import hwbPlugin from "colord/plugins/hwb";
    
    extend([hwbPlugin]);
    
    colord("#999966").toHwbString(); // "hwb(60 40% 40%)"
    colord("#99ffff").toHwbString(); // "hwb(180 60% 0%)"
    colord("#003366").alpha(0.5).toHwbString(); // "hwb(210 0% 60% / 0.5)"
    .toLab() (lab plugin)

    Converts a color to CIE LAB color space. The conversion logic is ported from CSS Color Module Level 4 Specification.

    import { colord, extend } from "colord";
    import labPlugin from "colord/plugins/lab";
    
    extend([labPlugin]);
    
    colord("#ffffff").toLab(); // { l: 100, a: 0, b: 0, alpha: 1 }
    colord("#33221180").toLab(); // { l: 14.89, a: 5.77, b: 14.41, alpha: 0.5 }
    .toLch() (lch plugin)

    Converts a color to CIE LCH color space. The conversion logic is ported from CSS Color Module Level 4 Specification.

    import { colord, extend } from "colord";
    import lchPlugin from "colord/plugins/lch";
    
    extend([lchPlugin]);
    
    colord("#ffffff").toLch(); // { l: 100, c: 0, h: 0, a: 1 }
    colord("#213b0b").toLch(); // { l: 21.85, c: 31.95, h: 127.77, a: 1 }
    .toLchString() (lch plugin)

    Converts a color to CIE LCH color space and expresses it through the functional notation.

    import { colord, extend } from "colord";
    import lchPlugin from "colord/plugins/lch";
    
    extend([lchPlugin]);
    
    colord("#ffffff").toLchString(); // "lch(100% 0 0)"
    colord("#213b0b").alpha(0.5).toLchString(); // "lch(21.85% 31.95 127.77 / 0.5)"
    .toXyz() (xyz plugin)

    Converts a color to CIE XYZ color space. 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 }

    Color manipulation

    .alpha(value)

    Changes the alpha channel value and returns a new Colord instance.

    colord("rgb(0, 0, 0)").alpha(0.5).toRgbString(); // rgba(0, 0, 0, 0.5)
    .invert()

    Creates a new Colord instance containing an inverted (opposite) version of the color.

    colord("#ffffff").invert().toHex(); // "#000000"
    colord("#aabbcc").invert().toHex(); // "#554433"
    .saturate(amount = 0.1)

    Increases the HSL saturation of a color by the given amount.

    colord("#bf4040").saturate(0.25).toHex(); // "#df2020"
    colord("hsl(0, 50%, 50%)").saturate(0.5).toHslString(); // "hsl(0, 100%, 50%)"
    .desaturate(amount = 0.1)

    Decreases the HSL saturation of a color by the given amount.

    colord("#df2020").saturate(0.25).toHex(); // "#bf4040"
    colord("hsl(0, 100%, 50%)").saturate(0.5).toHslString(); // "hsl(0, 50%, 50%)"
    .grayscale()

    Makes a gray color with the same lightness as a source color. Same as calling desaturate(1).

    colord("#bf4040").grayscale().toHex(); // "#808080"
    colord("hsl(0, 100%, 50%)").grayscale().toHslString(); // "hsl(0, 0%, 50%)"
    .lighten(amount = 0.1)

    Increases the HSL lightness of a color by the given amount.

    colord("#000000").lighten(0.5).toHex(); // "#808080"
    colord("#223344").lighten(0.3).toHex(); // "#5580aa"
    colord("hsl(0, 50%, 50%)").lighten(0.5).toHslString(); // "hsl(0, 50%, 100%)"
    .darken(amount = 0.1)

    Decreases the HSL lightness of a color by the given amount.

    colord("#ffffff").darken(0.5).toHex(); // "#808080"
    colord("#5580aa").darken(0.3).toHex(); // "#223344"
    colord("hsl(0, 50%, 100%)").lighten(0.5).toHslString(); // "hsl(0, 50%, 50%)"
    .mix(color2, ratio = 0.5) (mix plugin)

    Produces a mixture of two colors and returns the result of mixing them (new Colord instance).

    In contrast to other libraries that perform RGB values mixing, Colord mixes colors through LAB color space. This approach produces better results and doesn't have the drawbacks the legacy way has.

    β†’ Online demo

    import { colord, extend } from "colord";
    import mixPlugin from "colord/plugins/mix";
    
    extend([mixPlugin]);
    
    colord("#ffffff").mix("#000000").toHex(); // "#777777"
    colord("#800080").mix("#dda0dd").toHex(); // "#af5cae"
    colord("#cd853f").mix("#eee8aa", 0.6).toHex(); // "#e3c07e"
    colord("#008080").mix("#808000", 0.35).toHex(); // "#50805d"

    Color analysis

    .isValid()

    Returns a boolean indicating whether or not an input has been parsed successfully. Note: If parsing is unsuccessful, Colord defaults to black (does not throws an error).

    colord("#ffffff").isValid(); // true
    colord("#wwuutt").isValid(); // false
    colord("abracadabra").isValid(); // false
    colord({ r: 0, g: 0, b: 0 }).isValid(); // true
    colord({ r: 0, g: 0, v: 0 }).isValid(); // false
    .alpha()
    colord("#ffffff").alpha(); // 1
    colord("rgba(50, 100, 150, 0.5)").alpha(); // 0.5
    .brightness()

    Returns the brightness of a color (from 0 to 1). The calculation logic is modified from Web Content Accessibility Guidelines.

    colord("#000000").brightness(); // 0
    colord("#808080").brightness(); // 0.5
    colord("#ffffff").brightness(); // 1
    .isLight()

    Same as calling brightness() >= 0.5.

    colord("#111111").isLight(); // false
    colord("#aabbcc").isLight(); // true
    colord("#ffffff").isLight(); // true
    .isDark()

    Same as calling brightness() < 0.5.

    colord("#111111").isDark(); // true
    colord("#aabbcc").isDark(); // false
    colord("#ffffff").isDark(); // false
    .luminance() (a11y plugin)

    Returns the relative luminance of a color, normalized to 0 for darkest black and 1 for lightest white as defined by WCAG 2.0.

    colord("#000000").luminance(); // 0
    colord("#808080").luminance(); // 0.22
    colord("#ccddee").luminance(); // 0.71
    colord("#ffffff").luminance(); // 1
    .contrast(color2 = "#FFF") (a11y plugin)

    Calculates a contrast ratio for a color pair. This luminance difference is expressed as a ratio ranging from 1 (e.g. white on white) to 21 (e.g., black on a white). WCAG Accessibility Level AA requires a ratio of at least 4.5 for normal text and 3 for large text.

    colord("#000000").contrast(); // 21 (black on white)
    colord("#ffffff").contrast("#000000"); // 21 (white on black)
    colord("#777777").contrast(); // 4.47 (gray on white)
    colord("#ff0000").contrast(); // 3.99 (red on white)
    colord("#0000ff").contrast("#ff000"); // 2.14 (blue on red)
    .isReadable(color2 = "#FFF", options?) (a11y plugin)

    Checks that a background and text color pair is readable according to WCAG 2.0 Contrast and Color Requirements.

    colord("#000000").isReadable(); // true (normal black text on white bg conforms to WCAG AA)
    colord("#777777").isReadable(); // false (normal gray text on white bg conforms to WCAG AA)
    colord("#ffffff").isReadable("#000000"); // true (normal white text on black bg conforms to WCAG AA)
    colord("#e60000").isReadable("#ffff47"); // true (normal red text on yellow bg conforms to WCAG AA)
    colord("#e60000").isReadable("#ffff47", { level: "AAA" }); // false (normal red text on yellow bg does not conform to WCAG AAA)
    colord("#e60000").isReadable("#ffff47", { level: "AAA", size: "large" }); // true (large red text on yellow bg conforms to WCAG AAA)

    Color utilities

    random()

    Returns a new Colord instance with a random color value inside.

    import { random } from "colord";
    
    random().toHex(); // "#01c8ec"
    random().alpha(0.5).toRgb(); // { r: 13, g: 237, b: 162, a: 0.5 }
    ---

    Plugins

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

    a11y (Accessibility) 0.38 KB

    Adds accessibility and color contrast utilities working according to Web Content Accessibility Guidelines 2.0.

    import { colord, extend } from "colord";
    import a11yPlugin from "colord/plugins/a11y";
    
    extend([a11yPlugin]);
    
    colord("#000000").luminance(); // 0
    colord("#ccddee").luminance(); // 0.71
    colord("#ffffff").luminance(); // 1
    
    colord("#000000").contrast(); // 21 (black on white)
    colord("#ffffff").contrast("#000000"); // 21 (white on black)
    colord("#0000ff").contrast("#ff000"); // 2.14 (blue on red)
    
    colord("#000000").isReadable(); // true (black on white)
    colord("#ffffff").isReadable("#000000"); // true (white on black)
    colord("#777777").isReadable(); // false (gray on white)
    colord("#e60000").isReadable("#ffff47"); // true (normal red text on yellow bg conforms to WCAG AA)
    colord("#e60000").isReadable("#ffff47", { level: "AAA" }); // false (normal red text on yellow bg does not conform to WCAG AAA)
    colord("#e60000").isReadable("#ffff47", { level: "AAA", size: "large" }); // true (large red text on yellow bg conforms to WCAG AAA)
    hwb (HWB color model) 0.8 KB

    Adds support of Hue-Whiteness-Blackness color model.

    import { colord, extend } from "colord";
    import hwbPlugin from "colord/plugins/hwb";
    
    extend([hwbPlugin]);
    
    colord("#999966").toHwb(); // { h: 60, w: 40, b: 40, a: 1 }
    colord("#003366").toHwbString(); // "hwb(210 0% 60%)"
    
    colord({ h: 60, w: 40, b: 40 }).toHex(); // "#999966"
    colord("hwb(210 0% 60% / 50%)").toHex(); // "#00336680"
    lab (CIE LAB color space) 0.9 KB

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

    import { colord, extend } from "colord";
    import labPlugin from "colord/plugins/lab";
    
    extend([labPlugin]);
    
    colord({ l: 53.24, a: 80.09, b: 67.2 }).toHex(); // "#ff0000"
    colord("#ffffff").toLab(); // { l: 100, a: 0, b: 0, alpha: 1 }
    lch (CIE LCH color space) 1.3 KB

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

    import { colord, extend } from "colord";
    import lchPlugin from "colord/plugins/lch";
    
    extend([lchPlugin]);
    
    colord({ l: 100, c: 0, h: 0 }).toHex(); // "#ffffff"
    colord("lch(48.25% 30.07 196.38)").toHex(); // "#008080"
    
    colord("#646464").toLch(); // { l: 42.37, c: 0, h: 0, a: 1 }
    colord("#646464").alpha(0.5).toLchString(); // "lch(42.37% 0 0 / 0.5)"
    mix (Color mixing) 0.9 KB

    A plugin adding a color mixing utility.

    In contrast to other libraries that perform RGB values mixing, Colord mixes colors through LAB color space. This approach produces better results and doesn't have the drawbacks the legacy way has.

    β†’ Online demo

    import { colord, extend } from "colord";
    import mixPlugin from "colord/plugins/mix";
    
    extend([mixPlugin]);
    
    colord("#ffffff").mix("#000000").toHex(); // "#777777"
    colord("#800080").mix("#dda0dd").toHex(); // "#af5cae"
    colord("#cd853f").mix("#eee8aa", 0.6).toHex(); // "#e3c07e"
    colord("#008080").mix("#808000", 0.35).toHex(); // "#50805d"
    names (CSS color keywords) 1.29 KB

    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)
    colord("rgba(0, 0, 0, 0)").toName(); // "transparent"
    xyz (CIE XYZ color space) 0.7 KB

    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

    Colord is written in strict TypeScript and ships with types in the library itself β€” no need for any other install. We provide everything you need in one tiny package.

    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

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

    Install

    npm i colord

    DownloadsWeekly Downloads

    671,934

    Version

    2.0.1

    License

    MIT

    Unpacked Size

    87.6 kB

    Total Files

    35

    Last publish

    Collaborators

    • avatar