Template:Color box

 

Template documentation[view] [edit] [history] [purge]

For the templates that display text in a colored box, see {{Divbox}} or Template:Mbox templates see also.

Usage

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Color box in articles based on its 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-example⧽ Green	⧼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-example⧽ Hello, world!	⧼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-default⧽ Either black or white; whichever has greater contrast. ⧼templatedata-doc-param-example⧽ Yellow	⧼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-default⧽ black ⧼templatedata-doc-param-example⧽ #FF0	⧼templatedata-doc-param-type-string⧽	⧼templatedata-doc-param-status-optional⧽

Format: inline

<templatedata>{"format":"inline","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.","paramOrder":["1","2","3","border"],

"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>

Examples

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

Color box templates

Template	Description	Example
{{Color box}}	Color box size with black borders and text color. Standard size.	or  ORANGE
{{Color box striped}}	Striped color box. Standard size.
{{RouteBox}}	Borderless color box with text color and wikilinks.	ORANGE
{{Colorbull}}	Colored bullet with wikilinks.	■
{{Legend inline}}	Color box size with black borders. Standard size.
{{Color sample}}	Color box size with black borders. Smaller size.
{{Swatch inline}}		orange
{{Background color}}		orange
{{Rail color box}}	A version with more display options. Part of Module:Adjacent stations	●, Orange
{{Diagonal split color box}}	Color box split diagonally. Standard size.

Supporting template

• {{Greater color contrast ratio}}

See also

• {{Infobox color}}, an infobox for the detailed description of a color.
• {{Legend}}

The above documentation is transcluded from Template:Color box/doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this template.