get-best-contrast-color
v0.3.1
Published
Calculate the color in an array of colors that gives the highest contrast to another color.
Downloads
2,302
Maintainers
Readme
Get best contrast color
get-best-contrast-color
calculates which color in an array of colors gives the highest contrast to another color.
Doesn't handle transparency as of yet.
Installation
$ npm install get-best-contrast-color
Usage
import bestContrast from 'get-best-contrast-color';
// If you're not using EMS but CommonJS:
// const bestContrast = require('get-best-contrast-color').default;
const background1 = 'palevioletred';
const background2 = 'saddlebrown';
const colors = [
'#222',
'blue',
'rgb(255, 255, ,255)',
];
bestContrast(background1, colors); // '#222'
bestContrast(background2, colors); // 'rgb(255, 255, 255)'
Signature
(background: string, colors: array) => string
Contributing
I appreciate your issues and PRs on Github!
Testing
yarn build && yarn test
Releasing
This project uses np.
- Make sure your changes are in master
- Run
yarn release
- Follow the interactive release guide