Smart-foreground NPM

smart-foreground

Calculate matching foreground colors based on backgorund colors.

:cloud: Installation

# Using npm
npm install --save smart-foreground

# Using yarn
yarn add smart-foreground

:clipboard: Example

const smartForeground = require("smart-foreground");

console.log(smartForeground("black"));
// => #fffff

console.log(smartForeground("white"));
// => #00000

console.log(smartForeground("yellow"));
// => #00000

console.log(smartForeground("brown"));
// => #fffff

console.log(smartForeground("#F82125"));
// => #fffff

console.log(smartForeground("#FFC966"));
// => #00000

console.log(smartForeground("darkred", ["yellow", "#FF0057", "darkred"]));
// => yellow

console.log(smartForeground("yellow", ["yellow", "#FF0057", "darkred"]));
// => darkred

console.log(smartForeground("rgb(255, 25, 255)", ["yellow", "#FF0057", "darkred"]));
// => #FF0057

:question: Get Help

There are few ways to get help:

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

:memo: Documentation

`smartForeground(bgColor, fgColors)`

Get a good foreground color based on a backgorund color.

Params

String bgColor: The backgorund color (supports hex, rgb etc).
Array fgColors: An optional array of ordered foreground color codes (default: [black, white]). The lighter colors should be the first ones.

Return

String The best foregorund color to use (e.g. for a black background, by default it will return white).

: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