nilportugues / contrast-swatch

🅰️ Image microservice for color contrast information

Contrast Swatch

Image microservice for color contrast information

Usage

Contrast swatch images can be used in any place an image is rendered. The URL accepts a foreground and background color.

https://contrast.now.sh/cff/40f

HTML

<img src="https://contrast.now.sh/fff/07c" alt="color contrast indicator" />

Markdown

![color contrast indicator](https://contrast.now.sh/fff/07c)

React

You can wrap the image in a React component (or any templating engine) for generating documentation.

import React from 'react'

export default ({
  foreground,
  background,
  ...props
}) =>
  <img
    {...props}
    src={`https://contrast.now.sh/${foreground}/${background}`}
    alt='color contrast indicator'
  />

Customization

Use URL queries to customize the styles.

https://contrast.now.sh/fff/40f?width=256&height=96&fontSize=1.25

Pass/Fail Label

Font Size

Size

Width & Height

Custom Text

Options

Option	Description
size	Width & height in pixels
width	Width of image in pixels
height	Height of image in pixels (font size will scale based on height)
fontSize	Relative font size (default 1)
label	Show a pass/fail label based on the WCAG Criteria
text	Render any custom text

Metadata

A JSON response with color contrast information can be fetched by adding the type=json query to the URL.

https://contrast.now.sh/cff/40f?type=json

Note: the returned JSON schema might change in a future version

Related

• Colorable
• Use Contrast

MIT License