 | This template uses Lua:
|
This template creates a sprite from a sheet image. Commonly used when many small images are displayed on one page to reduce the total amount of HTTP connections.
Examples
{{Sprite
|pos=1
|align=text-top
|image=BlockCSS.png
|link=Grass Block
|text=Grass
|size=16
|sheetsize=256
}}
| Parameter
|
Function
|
Default value
|
align |
Sets the vertical alignment of the image to the text. |
middle
|
class |
Add additional classes to .sprite |
None
|
css |
Add styling to .sprite |
None
|
defaultpos |
The default position used if no position is set. |
1
|
image |
Sprite sheet image, without prefix |
None
|
link |
Create a link to this page |
None
|
name
|
Sets the name for this spritesheet, used to:
- get the position definitions: Module:Sprite/<name>
- part of the classname if it's in the imgClasses table:
<name:lower>-sprite
- part of the image name, if
image isn't set: <name>Sprite.png
|
None
|
pos |
Position index of the sprite, depends on size and sheetsize (left to right, starting at top-left sprite) |
defaultpos
|
scale |
Scale the sprite larger or smaller |
1
|
sheetsize |
Width of the whole sheet in pixels. Must be multiple of size |
256
|
size |
Size of each sprite in pixels, width and height |
16
|
text |
Show some text after the sprite, if link is set, this text will also be linked. |
None
|
title |
Set a title to be displayed when hovering over the sprite or text, overrides the link's title. |
None
|