JSPM

color-regex

1.0.2
    • ESM via JSPM
    • ES Module Entrypoint
    • Export Map
    • Keywords
    • License
    • Repository URL
    • TypeScript Types
    • README
    • Created
    • Published
    • Downloads 1148
    • Score
      100M100P100Q114618F
    • License MIT

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

    Package Exports

    • color-regex

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (color-regex) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme


    Color Regex

    color-regex

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

    Installation

    npm install color-regex

    Usage

    const Color = require('color-regex');

Color.format('#FF00FF'); // "hex"
Color.format('rgb(255, 100, 50)'); // "rgb"
Color.isRgb('rgb(255, 100, 50)'); // true
Color.isRgba('rgba(255, 100, 50, 0.5)'); // true
Color.array('rgb(255, 100, 50)'); // [ '255', '100', '50' ]
Color.array('hsl(230, 100%, 50%)'); // [ '230', '100%', '50%' ]
Color.array('hsla(320, 100%, 44%, 0.7)', true); // [ '320', '100', '44', '0.7' ]

    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

    const Color = require('color-regex');


//Get color format
console.log(Color.format('blue')); // "keyword"
console.log(Color.format('#FF00FF')); // "hex"
console.log(Color.format('rgb(255, 100, 50)')); // "rgb"
console.log(Color.format('rgba(255, 100, 50, 0.5)')); // "rgba"
console.log(Color.getFormat('hsl(230, 100%, 50%)')); // "hsl"
console.log(Color.getFormat('hsla(320, 100%, 44%, 0.7)')); // "hsla"
console.log(Color.getFormat('hsv(330, 93%, 98%)')); // "hsv"
console.log(Color.getFormat('hwb(0, 100%, 0%)')); // "hwb"


// Check color format
console.log(Color.isKeyword('blue')); // true
console.log(Color.isHex('#FF00FF')); // true
console.log(Color.isRgb('rgb(255, 100, 50)')); // true
console.log(Color.isRgba('rgba(255, 100, 50, 0.5)')); // true
console.log(Color.isHsl('hsl(230, 100%, 50%)')); // true
console.log(Color.isHsla('hsla(320, 100%, 44%, 0.7)')); // true
console.log(Color.isHsv('hsv(330, 93%, 98%)')); // true
console.log(Color.isHwb('hwb(0, 100%, 0%)')); // true

//Clear format and spaces
console.log(Color.clear('rgb(255, 100, 50)')); // "255,100,50"
console.log(Color.clear('rgba(255, 100, 50, 0.3)')); // "255,100,50,0.3"
console.log(Color.clear('hsl(230, 100%, 50%)')); // "230,100%,50%"
console.log(Color.clear('hsla(320, 100%, 44%, 0.7)')); // "320,100%,44%,0.7"


//To array, set true to remove symbols
console.log(Color.array('rgb(255, 100, 50)')); // [ '255', '100', '50' ]
console.log(Color.array('rgba(255, 100, 50, 0.3)', true)); // [ '255', '100', '50', '0.3' ]
console.log(Color.array('hsl(230, 100%, 50%)')); // [ '230', '100%', '50%' ]
console.log(Color.array('hsla(320, 100%, 44%, 0.7)', true)); // [ '320', '100', '44', '0.7' ]

    Collaborators

    Thanks

    License

    MIT