View source for Module:Color contrast/doc

<!-- Categories go at the bottom of this page and interwikis go in Wikidata. -->
{{module rating|protected}}
{{High-use|325916}}
{{Lua|Module:Color&nbsp;contrast/colors}}

This module is used primarily by 
* {{tl|Color contrast ratio}}
* {{tl|ColorToLum}} / {{tl|RGBColorToLum}}
* {{tl|Color contrast conformance}}
* {{tl|Ensure AAA contrast ratio}}
* {{tl|Ensure AA contrast ratio}}
* {{tl|Greater color contrast ratio}}
It is also used for tracking within
* [[Module:Navbox]]
* [[Module:Userbox]]
* [[Module:Episode list]]
and for documentation in
* [[Module:College color]]

The formulas used are [https://www.w3.org/WAI/GL/wiki/Relative_luminance#Definition_as_Stated_in_WCAG_2.x 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: <br> <code><nowiki>{{ColorToLum|color}}</nowiki></code> or <code><nowiki>{{#invoke:Color contrast|lum|color}}</nowiki></code>
* To compute a contrast ratio between two colors: <br> <code><nowiki>{{Color contrast ratio|color1|color2|error=?}}</nowiki></code> or <code><nowiki>{{#invoke:Color contrast|ratio|color1|color2|error=?}}</nowiki></code>
* To determine which of two colors (color2a and color2b) has the greater contrast ratio with a particular color (color1): <br> <code><nowiki>{{Greater color contrast ratio|color1|color2a|color2b}}</nowiki></code> or <code><nowiki>{{#invoke:Color contrast|greatercontrast|color1|color2a|color2b}}</nowiki></code>
* To compute the contrast ratio between the background and text colors specified in a css style string: <br> <code><nowiki>{{#invoke:Color contrast|styleratio|css style statement string|default background color|default text color}}</nowiki></code>

<includeonly>{{sandbox other||
[[Category:Modules handling colors]]
}}</includeonly>