Module:Color contrast/doc explained

This module is used primarily by

It is also used for tracking within

and for documentation in

The formulas used are stated in WCAG 2.x specifications. WCAG is the main guideline for creating accessible interfaces on the web.

Usage

To use this module, you may use one of the above listed templates or invoke the module directly

• To compute relative luminescence:
  <nowiki>{{ColorToLum|color}}</nowiki> or <nowiki>{{#invoke:Color contrast|lum|color}}</nowiki>
• To compute a contrast ratio between two colors:
  <nowiki>{{Color contrast ratio|color1|color2|error=?}}</nowiki> or <nowiki>{{#invoke:Color contrast|ratio|color1|color2|error=?}}</nowiki>
• To determine which of two colors (color2a and color2b) has the greater contrast ratio with a particular color (color1):
  <nowiki>{{Greater color contrast ratio|color1|color2a|color2b}}</nowiki> or <nowiki>{{#invoke:Color contrast|greatercontrast|color1|color2a|color2b}}</nowiki>
• To compute the contrast ratio between the background and text colors specified in a css style string:
  <nowiki>{{#invoke:Color contrast|styleratio|css style statement string|default background color|default text color}}</nowiki>