\n\n \n \n \n \n
\n \n \n
\n \n
![\"color](\"images/colorparsleyLOGO.png\")
\n\n\n## colorParsley()\n\n### A lightweight but versatile color parsing utility with no dependencies\n\n[Current Version:](./docs/versionHistory.md) **0.1.8**\n\n**NEW in 0.1.8: colorToHex and colorToRGB now round by default, and input strings using CSS color() have output array values multiplied by 255 for consistency with all other arrays..**\n**NEW in 0.1.7: output array will now *always* have an alpha value, with the default as 1 for inputs that lack an alpha. \"Failed\" parsings will return an alpha of 0.**\n\nColoR PaRsLeY is a spin off of the SAPC/APCA project. It is a lightweight but powerful tool for parsing color values out of various string types. It supports HEX, RGB INT, HTML & CSS Named Colors, and a variety of additional color models.\n\nColoR PaRsLeY returns a simple four element array of RGBA INT for HEX or RGB INT inputs, but longer arrays are available for the specialty category. \n\n## QuickStart\n\n_NPM Install:_ ` npm i colorparsley `\n\n\n### *Usage:*\n\"colorParsley()\" send it a string, it returns an rgba INT array:\n\n```javascript\n let textColor = colorParsley('#111111');\n let backgroundColor = colorParsley('rgb(123,23,233,1.0)');\n\n console.log(textColor); // [17,17,17,1,true,'sRGB']\n console.log(backgroundColor); // [123,23,233,1,true,'sRGB']\n \n // STRUCTURE\n returnedArray = [R,G,B,A,isValidBool,colorspaceString]\n```\n\nThe following are the available input types for colorParsley(). **All are automatically recognized:**\n\n### INPUT as STRINGS:\n- **No Alpha**\n - ` '#abc' ` or ` 'abc' ` (interpreted as ` 'aabbcc' `)\n - ` '#abcdef' ` or ` 'abcdef' ` (hash is ignored)\n - ` 'rgb(123, 45, 67)' ` or ` '123,45,67' `\n - ` 'aquamarine' ` or ` 'magenta' ` (full CSS4 named colors list)\n - ` 'color(srgb 0.765 0.89 0.556)' `\n- **With Alpha**\n - ` '#abcf' ` or ` 'abcf' ` (interpreted as ` 'aabbccff' `)\n - ` '#123456ff' ` or ` '123456ff' ` (hash is ignored)\n - ` 'rgba(123, 45, 67, 1.0)' `\n - ` 'color(srgb 0.765 0.89 0.556 / 1)' `\n- **Greyscale Shorthand**\n - ` '#ab' ` or ` 'ab' ` (interpreted as if` 'ababab' `)\n - ` '123,' `(interpreted as if` 'rgb(123, 123, 123)' `)\n - ` '87%' `(interpreted as if ` 'rgb(87%, 87%, 87%)' = [221.85,221.85,221.85]`)\n\n### NEW:\n\n- CSS 4 compatible changes:\n - INTs changed to NUMBER (i.e. 123 can now be 123.9586)\n - Added support for `color(srgb 0.765 0.89 0.556 / 1)`\n- HSL and HWB now!\n - `hsl(310,40%,60%, 1)` (alpha optional)\n- NEW export utilities for hex and rgb strings\n - `colorToHex(colorParsley('rgb(170,187,204)'))` returns `abc`\n - `colorToRGB(colorParsley('abc'))` returns `rgb(170,187,204)`\n- Better error handling—now errors return [0,0,0,'',false,'<error message>']\n- Send it an object containing {r: g: b:} or {red: green: blue:}\n- Send it a simple array [r,g,b,a]\n- Greyscale shortcuts!\n - For HEX, just two digits: a7 means `#a7a7a7`\n - For INT, 1-3 digits followed by a comma: 123, means `rgb(123,123,123)`\n - For PCT, 1-3 digits followed by a `%`: 87% means `rgb(87%,87%,87%)`\n - and is output as ` [221.85,221.85,221.85,'',...] `\n- \"More better\" regex validations and input type steering\n - Each RGB value must be 0.0-255.0. Alpha is 0.0-1 or 0% to 100%\n - Alpha values with percent symbol are converted to 0.0-1.0\n - RGB Color values in percent are converted to 0.0-255.0 \n- regex parsing for lch, hsv, luv, etc.\n - first 3-5 characters defines the color type\n - minimal verification and maximum flexibility for different color space and color model types.\n - Supports INT, float, and percentage with % symbol.\n - All values with percent symbol are converted to 0.0-1.0\n - NOTE: at this time, these are not processed into an rgba array and\n - other than percentage, values are left as is, and\n - the color type is returned as the sixth element in the array\n\n### Sending as a NUMBER:\n- **As hex**\n - ` 0xabcdef `\n- **As integer**\n - ` 11259375 `\n\nNo alpha parsing for _numbers_\n\n### RETURNS\n- All hex and rgb() inputs return a 6 element rgba NUMBER array\n - `[255,255,255,1,true,'sRGB']`\n- A value input with a percentage symbol % is divided by 100.0\n- Values are assumed to be 8bit unless a decimal point is found.\n\n- The \"isValid\" boolean is the 5th element in the return array.\n- The 6th array element is colorspace or model (i.e. hsl) (default sRGB)\n - `[255,255,255,1,true,'sRGB']`\n\n### Future\nPassthrough values to be added to the array to be returned. \n- An optional 7th array element is the gamma or TRC (default sRGB or per table)\n - `[322,0.7,0.5,1,'hsv',2.2]`\n- An optional 8th array element is the bitdepth (default 8bit per channel)\n - `[0.95,1.1,0.76,1,'RGB','1.0','32.0f','D65']`\n - \n- An optional 9th array element is the whitepoint (default D65)\n - `[123,123,123,1,'ProPhoto','1.8','D50']`\n\nThoughts? Discuss at the repo!\n\n-----\n## COMPANION CODE SNIPPET\nThe following code snippet is useful for auto-enter entry fields where you want instant response. This function cleans up entry keys as needed — adjust the keys to allow for your interface.\n\nHere the function just calls colorParsley(), but of course add whatever calls you need.\n\n```javascript\n // Entry Key Cleanup for better UX with auto-enter\n \n function entryKeys(colorString,e) {\n if (\n (\n (e.which >= 48 && e.which <= 57 && event.shiftKey == false) || // 0-9\n (e.which >= 65 && e.which <= 90) || // a-z\n (e.which >= 96 && e.which <= 105) // num keypad\n ) ||\n e.which === 13 || // enter\n e.which === 9 || // tab key\n e.which === 188 || // comma key\n e.which === 194 || // comma num keypad key\n //e.which === 8 || // backspace\n //e.which === 17 || // ctrl\n //e.which === 46 || // delete\n //(e.which >= 91 && e.which <= 93) || // OS key\n (e.which === 48 && event.shiftKey == true) // close parenthesis\n ) {\n let myNewColor = colorParsley(colorString);\n showMeTheColor(myNewColor); // the function to do on entry.\n }\n }\n```\nThen in your input field, use ` onkeyup =` (or other appropriate event)\n\n```HTML\n \n```\n\n### The NEW CoLoR PaRsLeY REGEX:\n\n![\"the](\"./images/colorParsleyRegexFlowchart.png\")
\n\nRegex flow chart svg created at https://www.debuggex.com/\n\n\n### Reference code from CSS \n\n```javascript\n\n//* // hslToRgb() hwbToRgb() from CSS shown here only as a reference\n\n///// ƒ hslToRgb() ///////////////////////////////////////////////////\n\n //// Unused, built into the string parser, here for reference\nfunction hslToRgb (hue, sat, light) { // CSS4 reference implementation\n hue = hue % 360;\n if (hue < 0) { hue += 360; }\n sat /= 100.0;\n light /= 100.0;\n function f(n) {\n let k = (n + hue/30) % 12;\n let a = sat * Math.min(light, 1 - light);\n return light - a * Math.max(-1, Math.min(k - 3, 9 - k, 1));\n }\n return [f(0), f(8), f(4)]; // returns 0.0 - 1.0\n};\n\n\n///// ƒ hwbToRgb() ///////////////////////////////////////////////////\n\n //// Unused, built into the string parser, here for reference\nfunction hwbToRgb(hue, white, black) { // CSS4 reference implementation\n white /= 100.0;\n black /= 100.0;\n if (white + black >= 1) {\n let gray = white / (white + black);\n return [gray, gray, gray];\n }\n let rgb = hslToRgb(hue, 100.0, 50.0);\n for (let i = 0; i < 3; i++) {\n rgb[i] *= (1 - white - black);\n rgb[i] += white;\n }\n return rgb; // returns 0.0 - 1.0\n};\n// */\n```\n\n\n\n","readmeFilename":"README.md"}