Devonnn: documentation for Template:Progress bar

2024-10-18T22:06:41Z

New page

== Useage ==
<nowiki>{{Progress bar
|amount=
|total=
|width=
|bar-color=
|background-color=
}}</nowiki>

== Examples ==
{| class="wikitable" style="width:100%;" {{table center}}
!{{table center}}| '''Code'''
!style=width:200px; vertical-align:middle;text-align:center;"| '''Result'''
|-
| <code><nowiki>{{Progress bar}}</nowiki></code>
| {{Progress bar|amount|total|width|bar-color}}
|-
| <code><nowiki>{{Progress bar|amount=10}}}</nowiki></code>
| {{Progress bar|amount=10|total=100}}
|-
| <code><nowiki>{{Progress bar|amount=10|total=45}}</nowiki></code>
| {{Progress bar|amount=10|total=45}}
|-
| <code><nowiki>{{Progress bar|amount=10|total=45|width=200px}}</nowiki></code>
| {{Progress bar|amount=10|total=45|width=100%}}
|-
| <code><nowiki>{{Progress bar|amount=10|total=45|width=100%|bar-color=red}}</nowiki></code>
| {{Progress bar|amount=10|total=45|width=100%|bar-color=red}}
|-
| <code><nowiki>{{Progress bar|amount=10|total=45|width=100%|bar-color=red|background-color=#aa0011}}}</nowiki></code>
| {{Progress bar|amount=10|total=45|width=100%|bar-color=red|background-color=#aa0011}}
|}

== Template Data ==
<templatedata>
{
"params": {
"width": {
"description": "Sets a custom width for the bar. By default, the width is 100px.",
"example": "300px, 400em, 50%, etc."
},
"amount": {
"description": "The amount of a thing (also functions as the numerator.) Should preferably be restricted to whole numbers. ",
"example": "1, 20, 50, 125, 15215"
},
"total": {
"description": "The total of a thing (also functions as the denominator.) Should preferably be restricted to whole numbers. ",
"example": "1000, 1024124, 12, 24",
"required": true
},
"bar-color": {
"description": "Allows you to change the color of the bar. Defaults to {{olb}}.",
"example": "#00000, #aaa, hsla(20, 80%, 100%, 0.5), etc."
}
},
"paramOrder": [
"amount",
"total",
"width",
"bar-color"
],
"description": "The progress bar is used to display progress between a total number and a partial number (i.e. 1 out of 100)."
}
</templatedata>

Template:Progress bar/doc - Revision history

Devonnn: documentation for Template:Progress bar