Color Regex

color-regex

Easily check the format of any color. Use diverse color helpers available to verify any color.

Installation

1npm install color-regex

Usage

1const Color = require('color-regex');
2
3Color.format('#FF00FF'); // "hex"
4Color.format('rgb(255, 100, 50)'); // "rgb"
5Color.isRgb('rgb(255, 100, 50)'); // true
6Color.isRgba('rgba(255, 100, 50, 0.5)'); // true
7Color.array('rgb(255, 100, 50)'); // [ '255', '100', '50' ]
8Color.array('hsl(230, 100%, 50%)'); // [ '230', '100%', '50%' ]
9Color.array('hsla(320, 100%, 44%, 0.7)', true); // [ '320', '100', '44', '0.7' ]
10

Supported formats

• keyword Example: "red" (black,white,red,green,yellow,magenta,cyan,gray,etc)
• hex Example: "#FFF000"
• rgb Example: "rgb(255, 255, 255)"
• rgba Example: "rgba(255, 255, 255, 0.3)"
• hsl Example: "hsl(0, 100%, 50%)"
• hsla Example: "hsla(0, 100%, 50%, 0.8)"
• hsv Example: "hsv(330, 93%, 98%)"
• hwb Example: "hwb(0, 100%, 0%)"

Examples

1
2const Color = require('color-regex');
3
4
5//Get color format
6console.log(Color.format('blue')); // "keyword"
7console.log(Color.format('#FF00FF')); // "hex"
8console.log(Color.format('rgb(255, 100, 50)')); // "rgb"
9console.log(Color.format('rgba(255, 100, 50, 0.5)')); // "rgba"
10console.log(Color.getFormat('hsl(230, 100%, 50%)')); // "hsl"
11console.log(Color.getFormat('hsla(320, 100%, 44%, 0.7)')); // "hsla"
12console.log(Color.getFormat('hsv(330, 93%, 98%)')); // "hsv"
13console.log(Color.getFormat('hwb(0, 100%, 0%)')); // "hwb"
14
15
16// Check color format
17console.log(Color.isKeyword('blue')); // true
18console.log(Color.isHex('#FF00FF')); // true
19console.log(Color.isRgb('rgb(255, 100, 50)')); // true
20console.log(Color.isRgba('rgba(255, 100, 50, 0.5)')); // true
21console.log(Color.isHsl('hsl(230, 100%, 50%)')); // true
22console.log(Color.isHsla('hsla(320, 100%, 44%, 0.7)')); // true
23console.log(Color.isHsv('hsv(330, 93%, 98%)')); // true
24console.log(Color.isHwb('hwb(0, 100%, 0%)')); // true
25
26//Clear format and spaces
27console.log(Color.clear('rgb(255, 100, 50)')); // "255,100,50"
28console.log(Color.clear('rgba(255, 100, 50, 0.3)')); // "255,100,50,0.3"
29console.log(Color.clear('hsl(230, 100%, 50%)')); // "230,100%,50%"
30console.log(Color.clear('hsla(320, 100%, 44%, 0.7)')); // "320,100%,44%,0.7"
31
32
33//To array, set true to remove symbols
34console.log(Color.array('rgb(255, 100, 50)')); // [ '255', '100', '50' ]
35console.log(Color.array('rgba(255, 100, 50, 0.3)', true)); // [ '255', '100', '50', '0.3' ]
36console.log(Color.array('hsl(230, 100%, 50%)')); // [ '230', '100%', '50%' ]
37console.log(Color.array('hsla(320, 100%, 44%, 0.7)', true)); // [ '320', '100', '44', '0.7' ]
38

Collaborators

• Max López

Thanks

• Log Beautify
• Color Regex
• Chalk

License

MIT