Template:Greater color contrast ratio
 | This template uses Lua: |
This template determines the pair of colors with the larger contrast ratio: color1/color2 or color1/color3. This is useful for selecting a foreground/background color pair. For accessibility, WCAG 2.0 AA guidelines require a contrast ratio of 3 or larger for large text, and 4.5 or larger for normal sized text.
In the default mode, color2 and color3 are white and black, and the selected color pair will always have a contrast ratio greater than 4.58.
Parameters[edit source]
A color input can be by name ("khaki") or hextriplet with/without #-prefix ("#F0E68C", "F0E68C") Template:Legend inline
|1=(required): background color|2=first fontcolor. Optional, default = white (#FFFFFF)|3=second fontcolor. Optional, default = black (#000000)
- The template returns the fontcolor with the greatest contrast
- background is Template:Legend inline: {{Greater color contrast ratio|khaki|white|black}} → black
- background is Template:Legend inline: {{Greater color contrast ratio|#4169E1|FFFFFF|000000}} → FFFFFF (=white)
- css text
|css=ymakes the template return css-ready text:
- Template:Legend inline:
{{Greater color contrast ratio|khaki|white|black|css=y}} - → background-color:khaki; color:black;
- Template:Legend inline:
- Example 1, Template:Legend inline
<span style="font-size:110%; {{Greater color contrast ratio|khaki|white|black|css=y}}">Example text on khaki background.</span>- →
<span style="font-size:110%; background-color:khaki; color:black;">Example text on khaki background.</span> - → Example text on khaki background.
- Example 2, Template:Legend inline
<span style="font-size:110%; {{Greater color contrast ratio|#4169E1|#ffffff|#000000|css=y}}">Example text on #4169E1 background.</span>- →
<span style="font-size:110%; background-color:#4169E1; color:#ffffff;">Example text on #4169E1 background.</span> - → Example text on #4169E1 background.
- bias
|bias=number: reduces contrast-check. A bias of 1.25, reduces the possible minimum to 4.0, which may not meet accessibility standards.
- This parameter should be used with caution to ensure accessibility. As stated above, when used without a bias, and with color2 and color3 equal to white and black, the selected color pair will always have a contrast ratio greater than 4.58.
Examples[edit source]
- Navy
<span style="background:navy; color:Template:Tlf">Navy</span>→ Navy<span style="Template:Tlf">Navy</span>→ Navy<span style="Template:Tlf">Navy</span>→ Navy
- Red
<span style="background:red; color:Template:Tlf">Red</span>→ Red<span style="Template:Tlf">Red</span>→ Red<span style="Template:Tlf">Red</span>→ Red
- White
<span style="background:white; color:Template:Tlf">White</span>→ White<span style="Template:Tlf">White</span>→ White
- Black
<span style="background:black; color:Template:Tlf">Black</span>→ Black<span style="Template:Tlf">Black</span>→ Black
- #005500
<span style="background:#005500; color:Template:Tlf">#005500</span>→ #005500<span style="Template:Tlf">#005500</span>→ #005500<span style="background:#005500; color:#Template:Tlf">005500</span>→ 005500<span style="Template:Tlf">005500</span>→ 005500
- CC5500
<span style="background:#CC5500; color:#Template:Tlf">CC5500</span>→ CC5500<span style="Template:Tlf">CC5500</span>→ CC5500
- CC5500,
|bias=1
<span style="background:#CC5500; color:#Template:Tlf">CC5500</span>→ CC5500<span style="Template:Tlf">CC5500</span>→ CC5500
- error
<span style="background:Not a color; color:#Template:Tlf">Not a color</span>→ Not a color<span style="Template:Tlf">Not a color</span>→ Not a color
- (returns
background-color:Not a color; color:;, and so no color is set; defaults to black-on-white.)
- (returns
<span style="Template:Tlf">Not a color</span>→ Not a color
- (returns
background-color:Navy; color:;, and so no fontcolor is set; defaults to black. The template did not function.)
- (returns