cc

colors-convert

🦚 A simple colors library

Showing:

Popularity

Downloads/wk

43

GitHub Stars

12

Maintenance

Last Commit

2mos ago

Contributors

4

Package

Dependencies

1

License

MIT

Type Definitions

Built-In

Tree-Shakeable

Yes?

Categories

Readme

Colors convert

A simple colors library

Using colors-convert you can:

  • read colors in different formats
  • analyze and manipulate colors
  • convert colors into different formats
  • give a name to a color
  • mix colors
  • create random colors.

How to use

yarn add colors-convert

or

npm install --save colors-convert

API overview

Go here to take a look at the complete API.

Color formats

Different color formats are supported: hex, rgb, rgba, hsl, hsla and cmyk.

Hex

A valid hex color can be:

  • #rrggbb[aa](6/8-digit, long form)
  • #rgb[a] (3/4-digit, short form) with r, g, b, a in [0-9a-fA-F].

Rgb

A valid rgb color is an object like this {r, g, b} with r, b, g numeric values in [0, 255].

Rgba

A valid rgba color is an object like this {r, g, b, a} with r, g, b numeric values in [0, 255] and a in [0, 1].

Hsl

A valid hsl color is an object like this {h, s, l} with:

  • h (hue): [0-359]°
  • s (saturation): [0-100]%
  • l (lightness): [0-100]%.

Hsla

A valid hsl color is an object like this {h, s, l} with:

  • h (hue): [0-359]°
  • s (saturation): [0-100]%
  • l (lightness): [0-100]%
  • a (alpha): [0-1].

Cmyk

A valid cmyk color is an object like this {c, m, y, k} with c, m, y, k numeric values in [0, 100].


Conversion

You can convert a color in any format to any other supported format.

from \ toHexRgbRgbaHslHslaCmyk
Hex\ hexToRgbhexToRgbahexToHslhexToHslahexToCmyk
RgbrgbToHex\ rgbToRgbargbToHslrgbToHslargbToCmyk
RgbargbaToHexrgbaToRgb\ rgbaToHslrgbaToHslargbaToCmyk
HslhslToHexhslToRgbhslToRgba\ hslToHslahslToCmyk
HslahslaToHexhslaToRgbhslaToRgbahslaToHsl\ hslaToCmyk
CmykcmykToHexcmykToRgbcmykToRgbacmykToHslcmykToHsla\
ColorcolorToHexcolorToRgbcolorToRgbacolorToHslcolorToHslacolorToCmyk

Specific functions by color format

Then there are more specific color format functions. You can also convert a Color to a redeable string format or a CSS string format. Go here to take a look at the complete API.

Other useful functions

  • name(color: Color): string: given a color (hex, rgb, rgba, hsl, hsla, cmyk), it returns the name of that color. It works using a list of 18315 unique color names.

  • mix(colors: Color[], weights?: number[]): rgb: mix two or more colors based on their weights.

  • randomHex(): HEX: return a random hex.

🎉 What's new in 1.3.0

  • [add] add the following functions: colorToHex, color2rgba, rgbaToHex, cmykToRgba, cmykToHsla, hexToHsla, rgbToHsla, rgbaToHsla, hslToRgba, colorToCmyk, colorToHsl, hslToHsla, colorToHsla, hslaStringToObject, hexToRgb, hexToRgba, shortToLongHex
  • [add] add hsla color format
  • [add] test coverage > 97%
  • [add] add api page
  • [add] add a new logo
  • [change] set as deprecated the following functions: color2string, color2cssString, hex2rgbOrRgba, hex2rgba, hex2hexWithAlpha, hex2cmyk, hex2hsl, rgb2hex, rgb2cmyk, rgb2hsl, rgb2rgba, color2rgb, rgbString2Object, rgba2rgb, rgbaString2Object, cmyk2hex, cmyk2rgb, cmyk2hsl, cmykString2Object, hsl2hex, hsl2rgb, hsl2cmyk, hslString2Object, getRandomColor,
  • [change] rgb2rgba has optional alpha parameter
  • [change] ColorName type: is no more a string but an object with name, hex and rgb
  • [fix] #00000 is not a valid hex color

Go here to see the CHANGELOG.

License

MIT © Ilaria Venturini

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100