flat-colors

flat-colors

Find the nearest flat color for a RGB/Hex input.

:cloud: Installation

# Using npm
npm install --save flat-colors

# Using yarn
yarn add flat-colors

:clipboard: Example

// Dependencies
var FlatColors = require("flat-colors")

// Get the flat red
console.log(FlatColors(255, 0, 0));
// => [211, 84, 0]

// Same thing, but using a rgb array
console.log(FlatColors([255, 0, 0]));
// => [211, 84, 0]


// Still same color but using hex color
console.log(FlatColors("#f00"));
// => [211, 84, 0]

// Random flat color
console.log(FlatColors());
// => [?, ?, ?]

:question: Get Help

There are few ways to get help:

1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
2. For bug reports and feature requests, open issues. :bug:
3. For direct and quick help, you can use Codementor. :rocket:

:memo: Documentation

FlatColors(r, g, b)

Finds the nearest flat color for rgb and hex inputs.

Params

• String|Number|Array r: The color as string in hex format, the red value or the rgb passed as array. If undefined, a random color will be returned.
• Number g: The green value.
• Number b: The blue value.

Return

• Array An array containing the rgb values of the flat color which was found.

toRgb(hex)

Converts a hex format color into rgb.

Params

• String hex: The color in the hex format.

Return

• Array The rgb array or null.

:yum: How to contribute

Have an idea? Found a bug? See how to contribute.

:sparkling_heart: Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

• Starring and sharing the projects you like :rocket:

• —I love books! I will remember you after years if you buy me one. :grin: :book:

• —You can make one-time donations via PayPal. I'll probably buy a coffee tea. :tea:

• —Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

• Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

  

Thanks! :heart:

:cake: Thanks

The color values are taken from flatuicolors.com. :art:

:dizzy: Where is this library used?

If you are using this library in one of your projects, add it in this list. :sparkles:

• color-it
• cli-confeti
• engine-builder
• flat-colors-groupped
• @isysd/gpm
• gpm
• cli-confetti

:scroll: License

MIT © Ionică Bizău