Template:Color box
Jump to navigation
Jump to search
Adds a rectangular color box.
Template documentationContents
Usage
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this TemplateData.
TemplateData for Color box
{{color box|color|text|text color}}Adds a rectangular color box.
- Colors are most commonly specified as either a color keyword or as the hexadecimal triplet representing an RGB combination. See the article web colors for details.
- If specified, the text is centered within the box.
| ⧼templatedata-doc-param-name⧽ | ⧼templatedata-doc-param-desc⧽ | ⧼templatedata-doc-param-type⧽ | ⧼templatedata-doc-param-status⧽ | |
|---|---|---|---|---|
| Color | 1 | Background color of the box.
| ⧼templatedata-doc-param-type-string⧽ | ⧼templatedata-doc-param-status-required⧽ |
| Text | 2 | Adds text inside the box; box is otherwise an empty square.
| ⧼templatedata-doc-param-type-string⧽ | ⧼templatedata-doc-param-status-suggested⧽ |
| Text color | 3 | Sets the color of the text inside the box.
| ⧼templatedata-doc-param-type-string⧽ | ⧼templatedata-doc-param-status-suggested⧽ |
| Border color | border | Sets the color of the border around the box.
| ⧼templatedata-doc-param-type-string⧽ | ⧼templatedata-doc-param-status-optional⧽ |
Format: inline
Test of raw TemplateData output:
<templatedata>{"description":"Adds a rectangular color box. Colors are most commonly specified as either a color keyword or as the hexadecimal triplet representing an RGB combination. See the article web colors for details.If specified, the text is centered within the box.","format":"inline",
"params":{ "1":{"suggested":true,"type":"string","description":"Background color of the box.","label":"Color","example":"Green","required":true},
"2":{"suggested":true,"type":"string","description":"Adds text inside the box; box is otherwise an empty square.","label":"Text","example":"Hello, world!"},
"3":{"suggested":true,"type":"string","description":"Sets the color of the text inside the box.","label":"Text color","example":"Yellow","default":"Either black or white; whichever has greater contrast."},
"border":{"type":"string","description":"Sets the color of the border around the box.","label":"Border color","example":"#FF0","default":"black"} }
}</templatedata>| Visual effect | Markup |
|---|---|
{{color box|Green}}
| |
| Default color for this text | {{color box|Yellow|Default color for this text}}
|
| Default color for this text | {{color box|Blue|Default color for this text}}
|
| Using X11 color names | {{color box|SteelBlue|'''Using X11 color names'''|Gold}}
|
| Using RGB hex triplets | {{color box|#012345|''Using RGB hex triplet''|#FEDCBA}}
|
| Red | {{color box|Yellow|Red|#f00|border=#f00}}
|
| bordercolor like wikitable | {{color box|white|bordercolor like wikitable|border=#A2A9B1}}
|
Variants
| Template | Description | Example |
|---|---|---|
| {{Color box}} | a small color box with black borders and text color | or ORANGE |
| {{RouteBox}} | a borderless version with text color and wikilinks | ORANGE |
| {{Colorbull}} | a colored bullet with wikilinks | ■ |
| {{Legend2}} | another borderless version | |
| {{Color sample}} | a small color box with black borders | |
| {{Swatch inline}} | orange | |
| {{Background color}} | orange | |
| {{Rail color box}} | a version with more display options (part of Module:Adjacent stations) |
●, Orange, etc. |
| {{Diagonal split color box}} | a small color box split diagonally | B R B R WB R W R WB W B W B B B B B W B B B B B B |
| {{Motor type}} | A small color box corresponding to the motor type | SI A |
Supporting template
See also
- {{Infobox color}}, an infobox for the detailed description of a color.
- {{Legend}}
