colorsheet

colorsheet

colorsheet is a small library containing several functions for converting between color formats and calculating things like contrast and luminance.

usage:

npm i colorsheet

then (example):

const colorsheet = require('colorsheet')

const emerald = colorsheet.hexToRGBA("#50c878")
// returns {r: 80, g: 200, b: 120}

here's what it exposes:

const colorsheet = {
  shiftHue: shiftHue,
  hexToRGBA: hexToRGBA,
  calculateLuminance: calculateLuminance,
  hslToRGB: hslToRGB,
  rgbToHSL: rgbToHSL,
  rgbToNHSL: rgbToNHSL,
  rgbToHex: rgbToHex,
  getWcagLevels: getWcagLevels,
  getContrastRatio: getContrastRatio
};

functions

calculateLuminance(r, g, b) ⇒ number

calculateLuminance - color to calculate the luminance of an rgb color

hexToRGBA(hex) ⇒ object

hexToRGBA - converts hex colors to rgb(a) colors

rgbToHex(r, g, b) ⇒ string

rgbToHex - converts rgb color to hex color

hslToRGB(h, s, l) ⇒ object

hslToRGB - convert hsl color to rgb

rgbToHSL(r, g, b) ⇒ object

rgbToHSL - convert rgb color to hsl color

rgbToNHSL(r, g, b) ⇒ object

rgbToNHSL - rgb to number hsl - hsl with decimal / integer values instead of typical hsl notation

shiftHue(rgb, deg) ⇒ object

shiftHue - shifts the hue value of an rgb color

getContrastRatio(hex1, hex2) ⇒ object

getContrastRatio - get the contrast rati between two colors

calculateLuminance(r, g, b) ⇒ number

calculateLuminance - color to calculate the luminance of an rgb color

kind: global function returns: number - luminance

param	type	description
r	number	color red from 0-255
g	number	color green from 0-255
b	number	color blue from 0-255

hexToRGBA(hex) ⇒ object

hexToRGBA - converts hex colors to rgb(a) colors

kind: global function returns: object - rgb object with r, g, b and optionally a keys

param	type	description
hex	string	hex color value as a string

rgbToHex(r, g, b) ⇒ string

rgbToHex - converts rgb color to hex color

kind: global function returns: string - string representing a hex color

param	type	description
r	number	red color number
g	number	green color number
b	number	blue color number

hslToRGB(h, s, l) ⇒ object

hslToRGB - convert hsl color to rgb

kind: global function returns: object - rgb object with red, green, and blue keys

param	type	description
h	number	hue number
s	number	saturation number
l	number	lightness number

rgbToHSL(r, g, b) ⇒ object

rgbToHSL - convert rgb color to hsl color

kind: global function returns: object - object with h, s, and l keys

param	type	description
r	number	red color number
g	number	green color number
b	number	blue color number

rgbToNHSL(r, g, b) ⇒ object

rgbToNHSL - rgb to number hsl - hsl with decimal / integer values instead of typical hsl notation

kind: global function returns: object - object containing hue, saturation, and lightness values

param	type	description
r	number	color red from 0-255
g	number	color green from 0-255
b	number	color blue from 0-255

shiftHue(rgb, deg) ⇒ object

shiftHue - shifts the hue value of an rgb color

kind: global function returns: object - rgb object with red, green, and blue keys

param	type	description
rgb	object	object with red, green, and blue keys
deg	number	amount to shift the hue of the color

getContrastRatio(hex1, hex2) ⇒ object

getContrastRatio - get the contrast rati between two colors

kind: global function returns: object - contrast ratio object with contrast ratio represented as a string and a decimal

param	type	description
hex1	string	first hex value for contrast calculation
hex2	string	second hex value for contrast calculation