Package Exports

get-contrast

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (get-contrast) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

get-contrast

Get the contrast ratio and WCAG score between common CSS color types. This also includes an is accessible method that returns a boolean value based on W3C Accessibility Standards.

It has the ability to handle rgb, rgba, hex, hsl, hsla, and named CSS colors.

Installation

npm i --save get-contrast

Usage

var contrast = require('get-contrast');

contrast.ratio('#fafafa', 'rgba(0,0,0,.75)') // => 10
contrast.score('#fafafa', 'rgba(0,0,0,.75)') // => 'AAA'
contrast.isAccessible('#fafafa', 'rgba(0,0,0,.75)') // => true
contrast.isAccessible('#fafafa', '#fff') // => false
contrast.score('rebeccapurple', 'tomato') // => 'F'

CLI

This module includes a command line interface contrast.

$ npm i get-contrast -g
$ contrast "#000" "#fff"
Ratio: 21
Score: AAA
# The second parameter defaults to #fff
$ contrast white
Ratio: 1
Score: F
The contrast is not accessible.
# Contrast will exit with an error code, when the values are not accessible.
$ contrast "#ff0" "#fff" && ./deploy.sh
Ratio: 1.0738392309265699
Score: F
The contrast is not accessible.

Acknowledgements

Uses the following packages:

Inspired by:

https://leaverou.github.com/contrast-ratio

License

MIT

Contributing

Fork it
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request

Crafted with <3 by John Otander (@4lpine).