Template:Color box

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

This template uses TemplateStyles:

Template:Legend/styles.css

This template is used on approximately 79,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

Preview message: Transclusion count updated automatically (see documentation).

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.

Parameter		Description	Type	Status
Color	`1`	Background color of the box. Example Green	String	required
Text	`2`	Adds text inside the box; box is otherwise an empty square. Example Hello, world!	String	suggested
Text color	`3`	Sets the color of the text inside the box. Default Either black or white; whichever has greater contrast. Example Yellow	String	suggested
Border color	`border`	Sets the color of the border around the box. Default black Example #FF0	String	optional

{
	"params": {
		"1": {
			"label": "Color",
			"description": "Background color of the box.",
			"example": "Green",
			"type": "string",
			"required": true,
			"suggested": true
		},
		"2": {
			"label": "Text",
			"description": "Adds text inside the box; box is otherwise an empty square.",
			"example": "Hello, world!",
			"type": "string",
			"suggested": true
		},
		"3": {
			"label": "Text color",
			"description": "Sets the color of the text inside the box.",
			"example": "Yellow",
            "type": "string",
			"suggested": true,
            "default": "Either black or white; whichever has greater contrast."
		},
		"border": {
            "label": "Border color",
			"description": "Sets the color of the border around the box.",
			"example": "#FF0",
            "type": "string",
            "default": "black"
		}
	},
	"description": "<noexport><code>&#123;&#123;color box&#124;''color''&#124;''text''&#124;''text color''&#125;&#125;</code><br></noexport>Adds a rectangular color box. <ul><li>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.</li><li>If specified, the text is centered within the box.</li></ul>",
	"format": "inline"	
}

**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
v
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}}

Template:Color box

Usage

Variants

Supporting template

See also