Template:Progress ring/doc: Difference between revisions

From Portals of Phereon Wiki
Content added Content deleted
mNo edit summary
mNo edit summary
Line 11: Line 11:
For more parameters, see TemplateData.
For more parameters, see TemplateData.


NB! Setting an ID is REQUIRED if there are more than one rings on the same page
NB! Setting an ID is Recommended if there are more than one rings on the same page


== Template data ==
== Template data ==

Revision as of 18:32, 13 April 2021

This is a documentation subpage for Template:Progress ring.
It contains usage information, categories and other content that is not part of the original template page.
60%

Creates a progress ring

Template style in Template:Progress_ring/ProgressRing.css

Usage

{{Progress ring|radius=40|width=8|color=green|percentage=0|id=anything}}

For more parameters, see TemplateData.

NB! Setting an ID is Recommended if there are more than one rings on the same page

Template data

Creates a progress ring

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
IDid

Set an ID unique to this particular ring (NO SPACES!)

Stringrequired
Percentagepercentage

The percentage displayed, enter without %

Default
0
Numberrequired
Radiusradius

Sets the radius of the circle (total diameter will be radius * 2)

Default
40
Numberoptional
Ring widthwidth

Width of the progress ring itself

Default
8
Numberoptional
Colorcolor

Sets the progress bar's color

Default
#fbfbfb
Unknownoptional
Animation timeanim-time

The time in seconds it takes for the ring to fill up (normalized based on percentage)

Default
0.5
Numberoptional
Text Sizesize

Set's the percentage text size (default: adaptive)

Numberoptional
Background colorbackground-color

Background progress ring color

Default
#d6dadc
Unknownoptional
Text Background Colorcenter-color

Percentage background text color

Default
#E0DCD4
Unknownoptional
Text Colortext-color

Percentage text color (default: percentage color)

Default
#d6dadc
Unknownoptional