Template:Item thumbnail/doc: Difference between revisions

Content added Content deleted

Inline

Revision as of 02:32, 12 July 2022

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

This template uses Lua:

Module:Item thumbnail

This template uses TemplateStyles:

Template:Item thumbnail/styles.css

This template uses the following Cargo tables:

Items

Parameters

Displays the thumbnail of an item with the count in the bottom right hand corner.

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
Item	`item`	The name of the item. Example Crystal	String	suggested
Count	`count`	The count associated with this thumbnail. Use "1" to not show anything. Example 1	Number	required
Image	`image`	The image used for the thumbnail. Automatically set if there is a valid item. Example Crystal.png	String	optional
Page link	`link`	The page this thumbnail links to. Automatically set if there is a valid item. Example Virtual coin	Page name	optional
Thumbnail size	`size`	The size of the thumbnail. The default size is "80px". Example 64px	String	optional

Quick copy

{{Item thumbnail
|item  =
|count =
|image =
|link  =
|size  =
}}

Examples

×100

×1000

{{Item thumbnail|item=Crystal|count=100}}
{{Item thumbnail|item=Cool piece|count=1000}}
{{Item thumbnail|item=Pure crystal of feeling|count=1}}

@@ Line 1: / Line 1: @@
 {{documentation subpage}}
-{{Lua|Module:Item thumbnail}} {{Cargo|Items}}
+{{Lua|Module:Item thumbnail}} {{Uses TemplateStyles|Template:Item thumbnail/styles.css}} {{Cargo|Items}}
-==Quick copy==
+== Parameters ==
+<templatedata>
+{
+	"params": {
+		"item": {
+			"type": "string",
+			"suggested": true,
+			"label": "Item",
+			"description": "The name of the item.",
+			"example": "Crystal"
+		},
+		"count": {
+			"type": "number",
+			"required": true,
+			"label": "Count",
+			"description": "The count associated with this thumbnail. Use \"1\" to not show anything.",
+			"example": "1"
+		},
+		"image": {
+			"type": "string",
+			"label": "Image",
+			"description": "The image used for the thumbnail. Automatically set if there is a valid item.",
+			"example": "Crystal.png"
+		},
+		"link": {
+			"type": "wiki-page-name",
+			"label": "Page link",
+			"description": "The page this thumbnail links to. Automatically set if there is a valid item.",
+			"example": "Virtual coin"
+		},
+		"size": {
+			"type": "string",
+			"label": "Thumbnail size",
+			"description": "The size of the thumbnail. The default size is \"80px\".",
+			"example": "64px"
+		}
+	},
+	"format": "inline",
+	"description": "Displays the thumbnail of an item with the count in the bottom right hand corner."
+}
+</templatedata>
+== Quick copy ==
 <pre>
 {{Item thumbnail
@@ Line 12: / Line 54: @@
 |size  =
 }}
+</pre>
+== Examples ==
+<div style="margin-top: 0.8rem; margin-bottom: 0.8rem; display: grid; grid-gap: 15px; grid-template-columns: repeat(auto-fill, minmax(80px, 1fr));">
+{{Item thumbnail|item=Crystal|count=100}}
+{{Item thumbnail|item=Cool piece|count=1000}}
+{{Item thumbnail|item=Pure crystal of feelings|count=1}}
+</div>
+<pre>
+{{Item thumbnail|item=Crystal|count=100}}
+{{Item thumbnail|item=Cool piece|count=1000}}
+{{Item thumbnail|item=Pure crystal of feeling|count=1}}
 </pre>