Template:Image frame: Difference between revisions
m (Fixed image margins) |
(Strip "px" from width, height, and border-width parameters) |
||
Line 1: | Line 1: | ||
<includeonly><!-- | <includeonly><!-- | ||
Image width. Defaults to a square aspect ratio if only height is provided. | Image width. Defaults to a square aspect ratio if only height is provided. | ||
-->{{#lvardef: width | {{{width|{{{w|{{{height|{{{h|100}}}}}}}}}}}}}}<!-- | -->{{#lvardef: width | {{#replace:{{{width|{{{w|{{{height|{{{h|100}}}}}}}}}}}}|px|}}}}<!-- | ||
Image height. Defaults to a square aspect ratio if only width is provided. | Image height. Defaults to a square aspect ratio if only width is provided. | ||
-->{{#lvardef: height | {{{height|{{{h|{{{width|{{{w|100}}}}}}}}}}}}}}<!-- | -->{{#lvardef: height | {{#replace:{{{height|{{{h|{{{width|{{{w|100}}}}}}}}}}}}|px|}}}}<!-- | ||
Border width. If this is 0, the outer div used for the border will not be created. | Border width. If this is 0, the outer div used for the border will not be created. | ||
-->{{#lvardef: border-width | {{{border-width|{{{bw|4}}}}}}}}<!-- | -->{{#lvardef: border-width | {{#replace:{{{border-width|{{{bw|4}}}}}}|px|}}}}<!-- | ||
Border frame shape. This can be either an arbitrary clip-path or one of the predefined values. | Border frame shape. This can be either an arbitrary clip-path or one of the predefined values. | ||
-->{{#lvardef: clip-path|{{#switch:{{{border-shape|{{{bs|rounded}}}}}} | -->{{#lvardef: clip-path|{{#switch:{{{border-shape|{{{bs|rounded}}}}}} | ||
Line 42: | Line 42: | ||
| image = Portrait Lae'zel.png | | image = Portrait Lae'zel.png | ||
| link = Lae'zel | | link = Lae'zel | ||
| h = | | h = 120px | ||
| bs = rounded | | bs = rounded | ||
| bw = | | bw = 2px | ||
| bc = red | | bc = red | ||
}} | }} |
Revision as of 20:43, 20 July 2024
Render an image cropped into a frame of arbitrary shape. The shape of the border or frame is defined by a CSS clip-path or can use one of the predefined shapes (rounded, diamond, basic).
Examples
Markup | Renders as |
---|---|
{{Image frame | image = Portrait Lae'zel.png | link = Lae'zel | width = 120 | border-shape = diamond | border-width = 4 }} | |
{{Image frame | image = Portrait Lae'zel.png | link = Lae'zel | h = 120px | bs = rounded | bw = 2px | bc = red }} | |
{{Image frame | image = Portrait Lae'zel.png | link = Lae'zel | height = 120 | border-shape = polygon(20% 0%, 80% 0%, 100% 20%, 100% 80%, 80% 100%, 20% 100%, 0% 80%, 0% 20%); | border-width = 2 | border-color = #3d3d3d }} | |
{{Image frame|Portrait Lae'zel.png|Lae'zel|h=120|bw=0}} |
Template data
Render an image cropped into a frame of arbitrary shape.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Image | 1 image | The image file to display. | File | required |
Link | 2 link | Clicking the image redirects to this link instead of the image file. | Page name | suggested |
Height | height h | The height of the image in pixels (does not include any additional height from the border size).
| Number | suggested |
Width | width w | The width of the image in pixels (does not include any additional width from the border size).
| Number | optional |
Border shape | border-shape bs | The shape of the border frame. It can be an arbitrary CSS clip path or use one of the predefined values.
| String | suggested |
Border color | border-color bc | The color of the border frame. This can be any CSS color descriptor.
| String | optional |
Border width | border-width bw | The thickness of the border frame in pixels. Set this to 0 to disable the border entirely.
| Number | optional |