Module:Gridiron color
This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing. |
This Lua module is used on approximately 37,000 pages and changes may be widely noticed. Test changes in the module's /sandbox or /testcases subpages, or in your own module sandbox. Consider discussing changes on the talk page before implementing them. |
The accessibility of this module is in question. The specific issue is: insufficient color contrast for some teams. Relevant discussion may be found on the talk page. |
This module depends on the following other modules: |
Implements:
- {{Gridiron primary color}}
- {{Gridiron primary style}}
- {{Gridiron alt primary style}}
- {{Gridiron secondary color}}
- {{Gridiron alt primary color}}
- {{Gridiron alt secondary color}}
Uses color data from Module:Gridiron color/data.
Usage
Debugging
Displays entire row from Module:Gridiron color/data for team and year passed in template call or using |team=
and |year=
(if omitted from invoke, module will take values from the template call):
{{#invoke:Gridiron color|test|team=team name (optional)|year=#### (optional)}}
["Buffalo Bills"] = {{ "#00274D", #FFFFFF", #C60C30", #C60C30", #FFFFFF"}}
Return team color
Returns either raw color value or prefixed color value. |column=
uses the following values:
- Primary color (background)
- Secondary color (text)
- Tertiary color raw (border)
- Alt primary color
- Alt secondary color
Set |raw=true
to display raw hex values. Team name and year passed in template call or specified using |team=
and |year=
:
{{#invoke:Gridiron color|color|column=#|raw=true (optional)|team=team name (optional)|year=#### (optional)}}
background: #00274D
Return team style
Returns complete CSS style for given team. A border will be displayed using the tertiary color if |border=
is set to "true" (in which case the border will be 2px wide) or to a positive integer value (in which case the width will be the value specified in pixels). Team name and year passed in template call or specified using |team=
and |year=
:
{{#invoke:Gridiron color|style|border=# or yes (optional)|team=team name (optional)|year=#### (optional)}}
background-color: #00274D !important; color: #FFFFFF !important; box-shadow: inset 2px 2px 0 #C60C30, inset -2px -2px 0 #C60C30;
--
-- This module implements
-- {{Gridiron primary color}} -- {{Gridiron primary style}} -- {{Gridiron alt primary style}}
-- {{Gridiron secondary color}}
-- {{Gridiron alt primary color}} -- {{Gridiron alt secondary color}}
--
local p = {}
local color_data = mw.loadData("Module:Gridiron color/data")
local yesno = require('Module:Yesno')
local prefixes = {
"background: ",
"color: ",
"/**/",
"background: ",
"color: "
}
local default = {"#DCDCDC", "#000000", "none", "", ""}
local function get_year(colors, year)
if colors and colors[6] and type(colors[6] == 'table') then
for team, year_colors in pairs(colors[6]) do
if mw.ustring.find(team, "%d%d%d%dthru%d%d%d%d$") then
local start_year, end_year = mw.ustring.match(team, "(%d%d%d%d)thru(%d%d%d%d)$")
if (tonumber(start_year) <= tonumber(year)) and (tonumber(year) <= tonumber(end_year)) then
return year_colors
end
end
end
end
return colors
end
local function get_colors(team, unknown, year)
team = (team or ''):match("^%s*(.-)%s*$")
year = tonumber(year)
default = color_data and color_data["#default"] or default
unknown = unknown or default
local use_default = {
[""] = 1,
["retired"] = 1,
["free agent"] = 1,
}
local colors = unknown
if (not use_default[team:lower()]) then
if mw.ustring.find(team, "%d?%d?%d%dthru%d?%d?%d%d$") then
if (not year or year <= 0) then
team, year = mw.ustring.match(team, "^(.-) -(%d?%d?%d%d)thru%d?%d?%d%d$")
team, year = team:match("^%s*(.-)%s*$"), tonumber(year)
if year >= 20 and year < 100 then -- Two-digit years were deprecated in 2018
year = year + 1900
elseif year < 20 then
year = year + 2000
elseif year < 1000 then
year = nil
end
else
team = mw.ustring.match(team, "^(.-) -%d?%d?%d%dthru%d?%d?%d%d$") or team
end
end
if color_data then
if year and year > 0 then
--code for handling year parameter
colors = get_year(color_data[team], year)
else
colors = color_data[team]
end
end
if ( colors and type(colors) == 'string') then
if team == colors then year = nil end
-- follow alias recursively
return get_colors (colors, unknown, year)
end
end
return colors or unknown
end
local function bordercss(c, w)
if w > 0 then
local s = 'inset ' .. w .. 'px ' .. w .. 'px 0 ' .. c
.. ', inset -' .. w .. 'px -' .. w .. 'px 0 ' .. c
return 'box-shadow: ' .. s .. ';'
else
return ''
end
end
local function contrast_check(background, text, colors, alt)
local c_limit = 3
local contrast = require('Module:Color_contrast')
if contrast._ratio({[1] = text, [2] = background, ['error'] = 0}) < c_limit then
if contrast._ratio({[1] = '#FFFFFF', [2] = background, ['error'] = 0}) >= c_limit then
text = '#FFFFFF'
elseif contrast._ratio({[1] = '#000000', [2] = background, ['error'] = 0}) >= c_limit then
text = '#000000'
elseif (not alt) and (contrast._ratio({[1] = colors[5], [2] = colors[4], ['error'] = 0}) >= c_limit) then
background, text = colors[4], colors[5]
else
background, text = default[1], default[2]
end
end
return background, text
end
function p.test(frame)
local args = frame.args.team and frame.args or frame:getParent().args
local colors = get_colors((args.team or args[1]), nil, args.year)
return '["' .. args.team .. '"] = {{ "' .. colors[1] .. '", '.. colors[2] ..
'", '.. colors[3] .. '", '.. colors[4] .. '", '.. colors[5] .. '"}}'
end
function p.color(frame, column, altcolumn)
local args = frame.args.team and frame.args or frame:getParent().args
local colors = get_colors((args.team or args[1]), nil, args.year)
column = (column or tonumber(frame.args.column)) or 1
altcolumn = altcolumn or tonumber(frame.args.altcolumn)
if ((not colors[column]) or (colors[column] == '')) and altcolumn then
column = altcolumn
end
return (yesno(frame.args.raw) and "" or prefixes[column]) .. colors[column]
end
function p.style(frame)
local team = frame.args.team or frame.args[1] or frame:getParent().args.team or frame:getParent().args[1]
local year = frame.args.year or frame:getParent().args.year
local border = frame.args.border or frame:getParent().args.border
local alt = yesno(frame.args.alt or frame:getParent().args.alt)
local colors = get_colors(team, nil, year)
local background, text
if alt then
background, text = colors[4], colors[5] -- Alt colors (4 and 5)
end
if ((not background) or (background == '')) then
background = colors[1] -- Default to primary color (1)
end
if ((not background) or (background == '')) then
background = default[1] -- Default background color
end
if ((not text) or (text == '')) then
text = colors[2] -- Default text color (2)
end
if ((not text) or (text == '')) then
text = default[2] -- Default text color
end
background, text = contrast_check(background, text, colors, alt)
-- Add !important to prevent dark mode overrides
local style = 'background-color: ' .. background .. ' !important; color: ' .. text .. ' !important; '
-- Apply border based on the argument:
-- Use the primary color (1) for the border if 'alt' is true, otherwise use the tertiary color (3)
if tonumber(border) or yesno(border) then
border = tonumber(border) and border or 2
local border_color = alt and colors[1] or colors[3]
style = style .. bordercss(border_color, tonumber(border))
end
return style
end
return p