Module:Gridiron color/doc
 | This is a documentation subpage for Module:Gridiron color. It may contain usage information, categories and other content that is not part of the original module page. |
 | This module is rated as ready for general use. It has reached a mature state, is considered relatively stable and bug-free, and may be used wherever appropriate. It can be mentioned on help pages and other Wikipedia resources as an option for new users. To minimise server load and avoid disruptive output, improvements should be developed through sandbox testing rather than repeated trial-and-error editing. |
 | This Lua module is used on approximately 38,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. |
 | 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
[edit]Debugging
[edit]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
[edit]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
- Alt tertiary 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
[edit]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;