@super-effective/colorutils
v2.1.3
Published
A color utility to help with converting between formats and getting color details
Downloads
828
Maintainers
Readme
ColorUtils
A color utility to help with converting between formats and getting color details
Functions
hexToRgb
Converts a HEX color string to its RGB values
Example
import { hexToRgb } from 'colorutils';
const rgb = hexToRgb('#ff0000');
console.log(rgb);
// Object { red: 255, green: 0, blue: 0 }
hsvToRgb
Converts HSV color values to its RGB values
Example
import { hsvToRgb } from 'colorutils';
const rgb = hsvToRgb(0.5, 1, 1);
console.log(rgb);
// Object { red: 0, green: 255, blue: 255 }
rgbToHex
Converts RGB values to a HEX color string
Example
import { rgbToHex } from 'colorutils';
const hex = rgbToHex(0, 255, 0);
console.log(hex);
// #00ff00
hsvToHex
Converts HSV values to a HEX color string
Example
import { hsvToHex } from 'colorutils';
const hex = hsvToHex(240, 1, 1);
console.log(hex);
// #0000ff
hexToHsv
Converts a HEX color string to a HSV values
Example
import { hexToHsv } from 'colorutils';
const hsv = hexToHsv('#ff00ff');
console.log(hsv);
// Object { hue: 300, saturation: 1, value: 1 }
sanitizeHex
Sanitizes a hex string - removing invalid characters and expanding it to 6 characters, e.g.:
#1 => #111111
#12 => #111222
#123 => #112233
#1234 => #112233
zz123 => #112233
Example
import { sanitizeHex } from 'colorutils';
const sanitizedHex = sanitizeHex('x123!');
console.log(sanitizedHex);
// #112233
getPerceivedLuminance
Get the perceived brightness of a given color. See: https://www.w3.org/TR/AERT/#color-contrast
Example
import { getPerceivedLuminance } from 'colorutils';
const perceivedLum = getPerceivedLuminance('#000000');
console.log(perceivedLum);
// 0