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 beta. It is considered ready for widespread use, but as it is still relatively new, it should be applied with some caution to ensure results are as expected. |
 | 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 color raw}}
- {{Gridiron primary style}}
- {{Gridiron secondary color}}
- {{Gridiron secondary color raw}}
- {{Gridiron tertiary color raw}}
- {{Gridiron alt primary color}}
- {{Gridiron alt primary style}}
- {{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
- Secondary color
- Tertiary color
- Alternative primary color
- Alternative 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;