Module:Color contrast/doc

This is the documentation page for Module:Color contrast

This module is rated as ready for general use. It has reached a mature form and is thought to be bug-free and ready for use wherever appropriate. It is ready to mention on help pages and other Wikipedia resources as an option for new users to learn. To reduce server load and bad output, it should be improved by sandbox testing rather than repeated trial-and-error editing.

Uses Lua:

Module:Color contrast/colors

This module is used for tracking by Module:Navbox

UsageEdit

To compute relative luminescence

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

To compute a contrast ratio between two colors

<{{#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)

{{#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}}