ಮೋಡ್ಯೂಲ್:Color contrast/doc

This is the documentation page for ಮೋಡ್ಯೂಲ್:Color contrast

This Lua module is used on approximately ೩,೨೬,೦೦೦ pages, or roughly 2283% of all pages.
To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them.

This module depends on the following other modules:

Module:Color contrast/colors

This module is used primarily by

{{ColorToLum}} / {{RGBColorToLum}}

It is also used for tracking within

Module:Navbox

Module:Userbox

Module:Episode list

and for documentation in

Module:College color

Usage

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

To compute relative luminescence

{{ColorToLum|color}} or {{#invoke:Color contrast|lum|color}}

To compute a contrast ratio between two colors

{{Color contrast ratio|color1|color2|error=?}} or {{#invoke:Color contrast|ratio|color1|color2|error=?}}

To determine which of two colors (color2a and color2b) has the greater contrast ratio with a particular color (color1)

{{Greater color contrast ratio|color1|color2a|color2b}} or {{#invoke:Color contrast|greatercontrast|color1|color2a|color2b}}

To compute the contrast ratio between the background and text colors specified in a css style string

{{#invoke:Color contrast|styleratio|css style statement string|default background color|default text color}}