Iconbar/doc

This is the documentation page, it should be transcluded into the main template page. See Template:Documentation for more information
This template uses Module:Iconbar, a script written in Lua.
Please see wp:Lua and mw:Extension:Scribunto to learn more.

This template creates a bar made of icons.

{{iconbar |value= |title= |size= |full= |half= |empty= |reverse= |total= }}
Parameter Function Default value
value Integer value between 0 and 20. One "full" icon is shown for each increase of 2 to value (e.g. three are shown if value is 6 or 7, etc.), and if value is odd, a "half" icon is shown at the end of the bar. 0
title Mouseover text. If this parameter isn't specified, it falls back to value. None
size Width of each icon in CSS units like "px" or "em". Units default to "px". None
full "Full" icon. One of these is shown for each increase of 2 to value (e.g. three are shown if value is 6 or 7, etc.). None
half "Half" icon, used at the end of the bar if value is odd. None
empty "Empty" icon, used if value is 0 or if total is used and is higher than value. None
reverse Pass a value to display the "half" icon on the left end of the bar instead of the right. None
total Minimum number of icons to be shown. If value is lower than this, empty icons are shown to reach the minimum. None

Examples

  • 4/10 HP
    {{iconbar|value=4|title=|size=|full=Heart.svg|half=Half Heart.svg|empty=Empty Heart.svg|reverse=|total=10}}
Heart.svg Heart.svg Empty Heart.svg Empty Heart.svg Empty Heart.svg
  • 4/10 HP large
    {{iconbar|value=4|title=|size=18px|full=Heart.svg|half=Half Heart.svg|empty=Empty Heart.svg|reverse=|total=10}}
Heart.svg Heart.svg Empty Heart.svg Empty Heart.svg Empty Heart.svg
  • 5/10 HP with title
    {{iconbar|value=5|title=Lorem ipsum|size=|full=Heart.svg|half=Half Heart.svg|empty=Empty Heart.svg|reverse=|total=10}}
Heart.svg Heart.svg Half Heart.svg Empty Heart.svg Empty Heart.svg
  • 5/10 HP mob reversed with title
    {{iconbar|value=5|title=Lorem ipsum|size=|full=Mob Heart.svg|half=Mob Half Heart.svg|empty=Empty Heart.svg|reverse=yess|total=10}}
Empty Heart.svg Empty Heart.svg Mob Half Heart.svg Mob Heart.svg Mob Heart.svg

See also

Community content is available under CC BY-NC-SA 3.0 unless otherwise noted.