# contrast-color

> Determines the best contrast color to use. Give it a background color and it returns a foreground color (black or white by default but customizable).

Latest version **1.0.1** (published 2021-01-25) · ISC license · 0 weekly downloads

## Install

```sh
npm install contrast-color
pnpm add contrast-color
yarn add contrast-color
bun add contrast-color
```

## Health

**Score 23/100 (F)** — status: abandoned.

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2021-01-25 |
| First published | 2021-01-16 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | separate (@types/contrast-color) |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 23.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 24 |
| Author | Buster Collings |
| Maintainers | buster |
| Keywords | accessibility, background, black, bright, brighten, brightness, chroma, color, colors, contrast, convert, css, dark, darken, font, foreground, hex, hsl, hsv, light, lightness, luma, luminosity, rgb, text, wcag, white, yiq |

## Links

- npm: https://www.npmjs.com/package/contrast-color
- Repository: https://github.com/busterc/contrast-color
- Homepage: https://github.com/busterc/contrast-color#readme
- Issues: https://github.com/busterc/contrast-color/issues
- npm.io page: https://npm.io/package/contrast-color

## Alternatives

- [postcss-color-hex-alpha](https://npm.io/package/postcss-color-hex-alpha.md) — 6.4M weekly downloads
- [randomcolor](https://npm.io/package/randomcolor.md) — 348.0K weekly downloads
- [bows](https://npm.io/package/bows.md) — 1.3K weekly downloads
- [ep_prefer_color_scheme](https://npm.io/package/ep_prefer_color_scheme.md) — 260 weekly downloads
- [coc-yank](https://npm.io/package/coc-yank.md) — 61 weekly downloads

## Recent versions

- 1.0.1 (latest) — 2021-01-25
- 1.0.0 — 2021-01-16
- 0.1.1 — 2021-01-16
- 0.1.0 — 2021-01-16

## README

# contrast-color [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url] [![Coverage percentage][coveralls-image]][coveralls-url]
> Determines the best contrast color to use. Give it a background color and it returns a foreground color (black or white by default but customizable).

## FYI

- [YIQ](https://en.wikipedia.org/wiki/YIQ#:~:text=YIQ%20is%20the%20color%20space,used%20in%20quadrature%20amplitude%20modulation.)
- [Calculating Color Contrast](https://24ways.org/2010/calculating-color-contrast/)

## Demo ([try it for yourself](https://codepen.io/buster/pen/PoGXdze))
![](contrastColor.gif)

## Installation

```sh
$ npm install contrast-color
```

## Usage

```js
// Use via class instance
const ContrastColor = require('contrast-color');
const cc = new ContrastColor({
  bgColor: "navy",
  fgDarkColor: "navy",
  fgLightColor: "water",
  customNamedColors: {
    water: "#00D0FF",
  },
});

const defaultFgColor = cc.contrastColor();
const hasAquaBgColor = cc.contrastColor({ bgColor: "aqua" });

/* Results
{
  defaultFgColor: '#00D0FF', // water
  hasAquaBgColor: '#000080'  // navy
}
*/

// OR ...

// Use via static method
const { contrastColor } = require('contrast-color');

const hasRedBg = contrastColor({ bgColor: '#f00' });
const hasRedBgWithBlackFg = contrastColor({ bgColor: '#f00', threshold: 76 });
const hasYellowBg = contrastColor({ bgColor: 'yellow' });
const hasWhiteBgWithGreenFg = contrastColor({ fgDarkColor: '#008000' });
const hasBlackBgWithLimeFg = contrastColor({ bgColor: '#000000', fgLightColor: 'lime' });
const hasKitchenSink = contrastColor({ 
  bgColor: '#808080', 
  fgDarkColor: 'dirty', 
  fgLightColor: 'clean', 
  threshold: 129, 
  customNamedColors: { 
    dirty: '#f90', 
    clean: '#ff99ff' 
  } 
});

/* Results:
{
  hasRedBg: '#FFFFFF',              // white
  hasRedBgWithBlackFg: '#000000',   // black
  hasYellowBg: '#000000',           // black
  hasWhiteBgWithGreenFg: '#008000', // green
  hasBlackBgWithLimeFg: '#00FF00',  // lime
  hasKitchenSink: '#ff99ff'         // clean
}
*/
```

## API

### ContrastColor(defaults)

- #### defaults 

  `Optional`: `Object` with parameters to use.

  - ##### bgColor

    - `Optional` : `String` hex or named (e.g.`#ff0000`, `red`)
    - `Default`  : `#FFFFFF`

  - ##### fgDarkColor

    Is returned if `bgColor` is determined to be _light_

    - `Optional` : `String` hex or named (e.g.`#ff0000`, `red`)
    - `Default`  : `#000000`

  - ##### fgLightColor

    Is returned if `bgColor` is determined to be _dark_

    - `Optional` : `String` hex or named (e.g.`#ff0000`, `red`)
    - `Default`  : `#FFFFFF`

  - ##### defaultColor

    Is returned if `bgColor` is determined to be _invalid_

    - `Optional` : `String` hex or named (e.g.`#ff0000`, `red`)
    - `Default`  : `#000000`

  - ##### threshold

    - `Optional` : `Number` (0-255) used to adjust variance
    - `Default`  : `128`

  - ##### customNamedColors

    - `Optional` : `Object` used to override or add named colors (e.g. `{ blue: "#0074D9" }`)


### .contrastColor(options)

- #### options 

  `Requrired`: `Object` with parameters to use.

  - ##### bgColor

    - `Required` : `String` hex or named (e.g.`#ff0000`, `red`)

  - ##### fgDarkColor

    Is returned if `bgColor` is determined to be _light_

    - `Optional` : `String` hex or named (e.g.`#ff0000`, `red`)
    - `Default`  : `#000000`

  - ##### fgLightColor

    Is returned if `bgColor` is determined to be _dark_

    - `Optional` : `String` hex or named (e.g.`#ff0000`, `red`)
    - `Default`  : `#FFFFFF`

  - ##### defaultColor

    Is returned if `bgColor` is determined to be _invalid_

    - `Optional` : `String` hex or named (e.g.`#ff0000`, `red`)
    - `Default`  : `#000000`

  - ##### threshold

    - `Optional` : `Number` (0-255) used to adjust variance
    - `Default`  : `128`

  - ##### customNamedColors

    - `Optional` : `Object` used to override or add named colors (e.g. `{ blue: "#0074D9" }`)


## License

ISC © [Buster Collings]()


[npm-image]: https://badge.fury.io/js/contrast-color.svg
[npm-url]: https://npmjs.org/package/contrast-color
[travis-image]: https://travis-ci.com/busterc/contrast-color.svg?branch=master
[travis-url]: https://travis-ci.com/busterc/contrast-color
[daviddm-image]: https://david-dm.org/busterc/contrast-color.svg?theme=shields.io
[daviddm-url]: https://david-dm.org/busterc/contrast-color
[coveralls-image]: https://coveralls.io/repos/busterc/contrast-color/badge.svg
[coveralls-url]: https://coveralls.io/r/busterc/contrast-color

---
_Source: https://npm.io/package/contrast-color · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
