Template:HeroIcon/doc: Difference between revisions

Latest revision as of 21:57, 7 October 2024

This icon link template is used to add a small headshot of the hero with a link.

{{HeroIcon|Lash}}

{{HeroIcon|Lash|Jacob}}

No description.

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
icon	`icon` `1`	Set the image file name.	String	required
2	`2`	Set the alternative text to display.	String	optional
size	`size`	Set the size of the icon in px. Default 25 Example 20, 24, 32	Number	optional

@@ Line 1: / Line 1: @@
 == Usage ==
+This icon link template is used to add a small headshot of the hero with a link.
+== Examples ==
 <pre style="width:50%">
 {{HeroIcon|Lash}}
 </pre>
 {{HeroIcon|Lash}}
@@ Line 9: / Line 11: @@
 {{HeroIcon|Lash|Jacob}}
 </pre>
 {{HeroIcon|Lash|Jacob}}
-=== Parameters ===
+<templatedata>
-; p1 : Hero name (required).
+{
-; p2 : Custom name (optional).
+	"params": {
-; size : Size (optional). Default is 25px.
+		"2": {
-<noinclude>[[Category:Template documentation]]</noinclude>
+			"description": "Set the alternative text to display.",
+			"type": "string"
+		},
+		"icon": {
+			"aliases": [
+				"1"
+			],
+			"type": "string",
+			"description": "Set the image file name.",
+			"required": true
+		},
+		"size": {
+			"type": "number",
+			"description": "Set the size of the icon in px.",
+			"example": "20, 24, 32",
+			"default": "25"
+		}
+	},
+	"format": "inline",
+	"paramOrder": [
+		"icon",
+		"2",
+		"size"
+	]
+}
+</templatedata><noinclude>[[Category:Template documentation]]</noinclude>