/mod.ts | colors@v2.0.2

import * as colors from "https://deno.land/x/colors@v2.0.2/mod.ts";

A collection of functions to extract information from colors, generate shades and tints, convert to other color spaces, etc.

Note: All methods either accept RGB/RGBA colors as parameters or give RGB/RGBA colors as results. In order to work with other color spaces (eg. XYZ), convert them to RGB first.

Examples

Example 1

// Deno /x
import { rgbaFromHex, xyz, lab } from "https://deno.land/x/colors/mod.ts";

// Deno JSR
import { rgbaFromHex, xyz, lab } from "jsr:@retraigo/colors";

// Node JSR (after installation)
import { rgbaFromHex, xyz, lab } from "jsr:@retraigo/colors";

const color = rgbaFromHex("#fceff1");

// CIE XYZ color space
console.log(xyz(color));

// CIE LAB color space
console.log(lab(color));

// Conversion of color into all supported spaces
console.log(json(color));

Variables

v DELTA	6 / 29
v DELTA_ADD	4 / 29
v DELTA_CUBE	(6 / 29)^3
v DELTA_SQUARE	(6 / 29)^2
v STANDARD_ILLUMINANT	Standard illuminant D65

Functions

f average	Get average of colors. Can be used for grayscale.
f chroma	Calculate chroma
f cmyk	Convert RGB(A) to CMYK
f contrast	Get contrast ratio
f findClosestColor	Find the nearest neighbour of a color in a palette It would be more accurate to use consider luminance along with Euclidean distance but I chose to stay with distance for performance.
f fromLinear
f grayscale	Convert RGBA to grayscale using luminance
f hcg	Convert RGB(A) to HCG
f hex	Convert RGB(A) to Hex
f hsl	Convert RGB(A) to Hue, Saturation, Lightness
f hsv	Convert RGB(A) to Hue, Saturation, Value
f hue	Calculate hue using chroma
f inverseLabF	Inverse lab function
f invert	Invert HSV
f invertLinear	Invert a color linearly
f invertValue	Bright colors darken, dark colors brighten.
f json
f lab	CIE Lab color space
f labF	t = C / Cn ratio
f lightness	Get lightness of color.
f linearRgb	Get linear rgb values
f luminance	Calculate luminance from RGB or RGBA color
f max	Get maximum of r, g, b, a, scaled to [0, 1].
f meanDistance	Calculate mean distance between two colors
f min	Get minimum of r, g, b, a, scaled to [0, 1].
f mix	Mix with a different color. Copyright (c) 2006-2009 Hampton Catlin, Natalie Weizenbaum, and Chris Eppstein http://sass-lang.com
f perceivedLightness	Get perceived lightness
f rgbaFromHex	Convert Hexadecimal string to RGBA
f rgbFromCmyk	Convert CMYK to RGB
f rgbFromHsl	Convert HSL color to RGB
f rgbFromHsv	Convert HSV color to RGB
f rgbFromLab	Convert CIE Lab to Linear RGB color space
f rgbFromXyz	Convert CIE XYZ to Linear RGB color space
f saturation	Get saturation
f shade	Get a shade of the color
f string	Stringify the RGBA color
f tint	Get a tint of the color
f toHex
f toLinear
f xyz	CIE 1931 XYZ
f xyzFromLab	Convert CIE Lab* to CIE XYZ

Type Aliases

T Color1	1-Channel Color (Grayscale)
T Color3	3-Channel Color
T Color4	4-Channel Color
T ColorData	A record of color spaces and values for the color in those spaces.