pointofpresence/flat-colors.js

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

Check it

flat-colors

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

☁️ Installation

$ npm i --save flat-colors

📋 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());
// => [?, ?, ?]

📝 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.

😋 How to contribute

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

🍰 Thanks

The color values are taken from flatuicolors.com. 🎨

💫 Where is this library used?

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

• color-it—Flat colors for your Node.js strings.
• engine-builder (by jillix)—Engine composition parser.
• gpm—npm + git = gpm - Install NPM packages and dependencies from git repositories.

📜 License

MIT © Ionică Bizău