Skip to content
Branch: master
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
dist JavaScript release 0.0.3 Mar 5, 2018
README.md JavaScript release 0.0.3 Mar 5, 2018
api-full.js Cleanups for JavaScript build Jan 29, 2018
api-public.js
package.json
precision.js Rename HUSL -> HSLuv Dec 15, 2016
test.js Cleanups for JavaScript build Jan 29, 2018

README.md

HSLuv - Human-friendly HSL

Installation

Client-side: download the latest hsluv.min.js.

Once this module is loaded in the browser, you can access it via the global window.hsluv.

Server-side: npm install hsluv.

Usage

Most functions take tuples, ie: Javascript arrays with three elements. Make sure you are using func([a,b,c]) and not func(a,b,c). If you are getting NaN for output then this is probably the problem.

hsluvToHex([hue, saturation, lightness])

hue is a number between 0 and 360, saturation and lightness are numbers between 0 and 100. This function returns the resulting color as a hex string.

hsluvToRgb([hue, saturation, lightness])

Like above, but returns an array of 3 numbers between 0 and 1, for the r, g, and b channel.

hexToHsluv(hex)

Takes a hex string and returns the HSLuv color as array that contains the hue (0-360), saturation (0-100) and lightness (0-100) channel. Note: The result can have rounding errors. For example saturation can be 100.00000000000007

rgbToHsluv([red, green, blue])

Like above, but red, green and blue are passed as numbers between 0 and 1.

Use hpluvToHex, hpluvToRgb, hexToHpluv and rgbToHpluv for the pastel variant (HPLuv). Note that HPLuv does not contain all the colors of RGB, so converting arbitrary RGB to it may generate invalid HPLuv colors.

For advance use cases, additional functions are avalible:

hsluvToLch, lchToHsluv

hpluvToLch, lchToHpluv

rgbToXyz, xyzToRgb

rgbToLch, lchToRgb

luvToXyz, xyzToLuv

lchToLuv, luvToLch

Also available for Stylus. See here.

Changelog

0.0.3

  • Expose intermediate functions in the public API.

0.0.2

  • Improve packaging and minification.

0.0.1

  • Initial release under the name HSLuv. Old releases can be found here.
You can’t perform that action at this time.