Wikipedia>Sheep8144402: /* Optional parameters */ add color1 and color2

2022-03-30T14:54:08Z

Optional parameters: add color1 and color2

New page

{{Documentation subpage}}


{{Esoteric}}

== Usage ==
:<code>'''<nowiki>{{</nowiki>Progress bar|'''''value'''''<nowiki>}}</nowiki>'''</code>

This template draws a progress bar. By default, the <code>value</code> to supply as the parameter is the percent, from 0 to 100 (e.g. 1 would mean 1%, .1 would be 0.1%). The text label of the progress bar will always be rounded to the nearest tenth of a percent (rounding up if the hundreds digit is 5; e.g. 50.15 would round to 50.2%). If a value isn't specified or is invalid, the bar displays 0%. Values greater than 100% will display incorrectly, although the text label will be correct.

=== Optional parameters ===
*<code>height</code> = height of the progress bar in pixels; defaults to 2
*<code>width</code> = width of the progress bar; defaults to 75%
*<code>text</code> = message to display after %; defaults to: completed <small>(estimate)</small>
*<code>total</code> = amount to use as the denominator (instead of 100), allows the template to compute the percentage on the fly
*<code>header</code> = no (or any value other than "yes", which is the default) suppresses the display of the percentage on the top line
*<code>color1</code> = the colour of the filled portion of the progress bar
*<code>color2</code> = the colour of the background of the progress bar

=== Examples ===

==== Default configuration ====
<code><nowiki>{{Progress bar|5}}</nowiki></code> :
{{Progress bar|5}}

==== With custom header text ====
<code><nowiki>{{Progress bar|5|text=done}}</nowiki></code> :
{{Progress bar|5|text=done}}

==== Without header text ====
<code><nowiki>{{Progress bar|80|header=no|text=does not display here}}</nowiki></code> :
{{Progress bar|80|header=no|text=does not display here}}

==== Custom height and width ====
<code><nowiki>{{Progress bar|80|height=4|width=50%}}</nowiki></code> :
{{Progress bar|80|height=4|width=50%}}

==== Custom total ====
<code><nowiki>{{Progress bar|5|total=5}}</nowiki></code> :
{{Progress bar|5|total=5}}

{{Progress templates}}

<includeonly>{{Sandbox other||

[[Category:Wikipedia utility templates]]
[[Category:Wikipedia progress templates]]
}}</includeonly>

Template:Progress bar/doc - Revision history

Wikipedia>Sheep8144402: /* Optional parameters */ add color1 and color2