Template:Composition bar/doc

₫

This template displays the numeric composition of a thing in terms of its sub-units. For example, it is frequently used as part of Infobox political party to show the number of seats a given political party holds in a legislature. A single line, flexible width version of this template is available at Template:Composition bar compact.

Usage

 * amount
 * The first parameter is the number of sub-units.


 * total
 * The second parameter is the total number of sub-units possible.

In the case of political parties, most will have their logo color available in templates.
 * bar-color
 * (default is light grey) The third parameter is the background color of the left part of the bar - a valid web color, which can be specified by name, as a hex triplet (#rrbbgg), or rgb triplet (rgb(0–255,0–255,0–255)).

Additional display options:
 * background-color=...
 * (default is transparent) is the background color of the right part of the bar - a valid web color.


 * border=...
 * (default is medium grey) is the color of the border, or "none" for no border


 * width=...
 * (default is 100px) a width value for the bar, such as "100%" or "8em" (unitless numbers are interpreted as px)


 * per=...
 * (default is false), when set to any value (true), adds a percentage to the bar as well


 * ref=...
 * (default is blank), may be used to add a reference/citation for the numbers.

TemplateData
{   "description": "A composition bar.", "params": { "1": {           "label": "1", "description": "The number of sub-units.", "type": "string/line", "required": true },       "2": {            "label": "2", "description": "The total number of sub-units possible.", "type": "string/line", "required": true },       "3": {            "label": "3", "description": "The background color of the left part of the bar - a valid web color, which can be specified by name, as a hex triplet (#rrbbgg), or rgb triplet (rgb(0–255,0–255,0–255)). In the case of political parties, most will have their logo color available in  templates.", "default": "#CCCCCC", "type": "string/line", "required": false, "aliases": ["hex"] },       "background-color": { "label": "Background color", "description": "The background color of the right part of the bar - a valid web color.", "default": "transparent", "type": "string/line", "required": false },       "border": { "label": "Border color", "description": "The color of the border, or 'none' for no border", "default": "#AAAAAA", "type": "string/line", "required": false, "aliases": ["border-color"] },       "width": { "label": "Width", "description": "The width of the bar with units, such as 100% or 10em (unitless numbers are interpreted as px)", "default": "100px", "type": "string/line", "required": false },       "per": { "label": "Show percent", "description": "When set to 1 (true), adds a percentage to the bar as well", "default": "0", "type": "string/line", "required": false }   } }